open-ephys / bonsai-onix1

Bonsai library for the Open Ephys Onix Acquisition System
https://open-ephys.github.io/onix1-bonsai-docs
MIT License
4 stars 3 forks source link

Remove link to internal PortController class #239

Closed bparks13 closed 1 month ago

bparks13 commented 1 month ago

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.

cjsha commented 1 month ago

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>
bparks13 commented 1 month ago

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.