Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken <cref> tag in PortStatus.cs to PortController #233

Closed
cjsha opened this issue Aug 21, 2024 · 2 comments · Fixed by #239
Closed

Fix broken <cref> tag in PortStatus.cs to PortController #233

cjsha opened this issue Aug 21, 2024 · 2 comments · Fixed by #239
Milestone

Comments

@cjsha
Copy link
Member

cjsha commented Aug 21, 2024

PortStatus.cs has a <cref> reference to a member PortController of a private class ConfigurePortController which results in a broken link on the docs site because docfx is set to not generate pages for private classes.

Specifically line 15 below:

https://github.com/open-ephys/onix-bonsai-onix1/blob/70a29e51612ff23f440ff808fd44d1b9fb06e3a0/OpenEphys.Onix1/PortStatus.cs#L12-L16

@cjsha
Copy link
Member Author

cjsha commented Aug 21, 2024

I set this as the nearest milestone so we can update the docs to point to the latest commit as soon as possible.

@bparks13 bparks13 linked a pull request Aug 21, 2024 that will close this issue
@cjsha
Copy link
Member Author

cjsha commented Aug 21, 2024

If we want, I can make an exception for portController to render the page. However, if it's not accessible by the user, I agree with what bparks said in #239 about removing the the reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant