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

Remove link to internal PortController class #239

Merged
merged 1 commit into from
Aug 21, 2024
Merged

Remove link to internal PortController class #239

merged 1 commit into from
Aug 21, 2024

Conversation

bparks13
Copy link
Member

When building the docfx website, we do not render private or internal classes, leading to a broken reference.

A broken reference blocks that repo from merging pull requests, therefore we need to remove this reference.

- When building the docfx website, we do not render private or internal classes, leading to a broken reference
@bparks13 bparks13 added this to the 0.2.0 milestone Aug 21, 2024
@bparks13 bparks13 requested a review from cjsha August 21, 2024 15:57
@bparks13 bparks13 linked an issue Aug 21, 2024 that may be closed by this pull request
@cjsha
Copy link
Member

cjsha commented Aug 21, 2024

Fun, my first review in the onix-bonsai-onix1 repo.

I would say, if that's our only mention of PortController in the docs, and we're not going to expand on it any further, and there's no reference where they can learn what it is, I would remove that entire clause from the sentence.

    /// <remarks>
    /// This data stream class must be linked to an appropriate headstage,
    /// miniscope, etc. configuration whose communication is dictated by
    /// a PortController.
    /// </remarks>

would turn into something like:

    /// <remarks>
    /// This data stream class must be linked to an appropriate headstage,
    /// miniscope, etc. configuration.
    /// </remarks>

Copy link
Member

@cjsha cjsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My feedback exists in my previous comment, but I'm submitting this comment as well to submit my review.

@cjsha cjsha self-requested a review August 21, 2024 16:41
Copy link
Member

@cjsha cjsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm submitting another review with PR approval this time so that whatever you decide to do you can just go ahead and merge it

@bparks13
Copy link
Member Author

I agree with removing the whole clause actually, I thought that the language for PortController was listed in other places (i.e., other properties such as ConfigureHeadstage64PortController) but they are all internal classes/properties and as such are never served to the website.

@jonnew jonnew merged commit 5bafa91 into main Aug 21, 2024
6 checks passed
@jonnew jonnew deleted the issue-233 branch August 21, 2024 17:12
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 this pull request may close these issues.

Fix broken <cref> tag in PortStatus.cs to PortController
3 participants