Remove "a class that" from XML comments #261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
jonnew
commented
Aug 27, 2024
jonnew
commented
- Unnessesary jargon
- Other minore XML fixes while addressing this issue
- Fixes XML summary sentence structure for classes #209
- Move jargon from summary to remarks. - Expand remarks to explain jargon a bit and provide link to ONI spec.
- Bump version to 0.3.0
- Unnessesary jargon - Other minore XML fixes while addressing this issue
- Runs during pull requests to check that the version number is increasing - Skipped during pushes to main or releases
Add step to check semantic version
Add package types
Only skip check-semver during releases
Restrict possible driver values
- V2e and V2eBeta inherit from this interface - Modified V2e dialogs to accept the interface - V2eBeta operators call the V2e dialogs, due to the common interface, and modify strings as needed to specify 'Beta'
- Consolidated XML comments, now the summary is inherited from the interface for shared properties of NeuropixelsV2 devices
Remove unused usings
- Add details to class description about what the operator does and what it produces without cref links to clroni - Fix typo in BitHelper
- More details in class description
Standardize names for Neuropixels probes
Add NeuropixelsV2eBeta GUIs
- I was writing NeuropixelsV2eBeta.REC_MODE instead of NeuropixelsV2eBeta.OP_MODE which was preventing the probes from streaming data.
cjsha
approved these changes
Sep 4, 2024
Fix register write in NP2.0-beta streamong configuration
- Fix many typos in CreateContext XML comments
Improve the CreateContext documentation
Improve StartAqcuisition documentation
- More details in class description
- Try to remove all crefs to clroni and replace with hrefs to the specification itself.
Improve ContextTask documentation
- Unnessesary jargon - Other minore XML fixes while addressing this issue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.