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

Edits to XML comments: issues 355-357 #382

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

cjsha
Copy link
Member

@cjsha cjsha commented Dec 10, 2024

I came across typos mentioned in issues 355 & 356 a few times while working on the docs, and they bothered me each time so I decided to quickly take care of all three of these issues related to typos in XML comments:

I also figure it would fit in well with the other typo fix if we end up doing a 0.4.2 release


#357 (comment):

Remove small animals as well.

The above quote is in relation to the ConfigureHeadstageRhs2116 remarks. I took that feedback and applied it to the remarks of all ConfigureXyzHeadstage classes.


The following list describes all the changes made in 652784a:

  • remove hyphens used for unit prefixes
  • "microvolts" -> "millivolts" for DCData
  • "NeuropixelsV2e headstage" to "Intan Rhs2116 bioacquisition chip" in Rhs2116Data (like how it is in Rhd2164Data summary)
  • add "<see cref="Rhd2164DataFrame"/>" in Rhd2164Data summary (like how it is in Rhs2116Data summary)
  • add description attribute to Rhs2116Data class
  • remove "for small animals" and combine 1st & 2nd sentences in remarks for all ConfigureXyzHeadstage classes

- remove hyphens used for unit prefixes
- "microvolts" -> "millivolts" for DCData
- "NeuropixelsV2e headstage" to "Intan Rhs2116 bioacquisition chip" in Rhs2116Data  (like how it's done in Rhd2164Data summary)
- add "<see cref="Rhd2164DataFrame"/>" in Rhd2164Data summary (like how it's done in Rhs2116Data summary)
- add description attribute to Rhs2116Data class
- remove "for small animals" and combine 1st & 2nd sentences in summaries for all ConfigureXyzHeadstage classes
@cjsha cjsha requested review from jonnew and bparks13 December 10, 2024 17:30
Copy link
Member

@bparks13 bparks13 left a comment

Choose a reason for hiding this comment

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

This looks good to me, but I will wait to merge in case anything else comes up that we can edit here.

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