Move Neuropixels XML comments to common interface #494
Conversation
This file contains hidden or 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
jonnew
requested changes
Sep 16, 2025
- Remove all mention of a GUI - Update remark on InvertPolarity
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.
Instead of duplicating XML comments across devices, especially when these devices share a common interface, this PR moves all XML comments to the interface and the implementing classes now inherit the docs.
We still need to add specific comments for properties that are not in the interface, or when a property needs to reference an external class that is different for each device (e.g., referencing the correct
*Datanode).Also, consolidated some
Descriptionattributes so they are consistent.Fixes #488