Improve axon docstrings #1798
Open
Improve axon docstrings #1798
+618
−211
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
zm711
reviewed
Nov 8, 2025
Contributor
zm711
left a comment
zm711
left a comment
There was a problem hiding this comment.
I guess we haven't formally discussed Numpy doc-esque standards as a rule. I like all the info you're providing, but I think we should include a rationale in the PR explaining why you want these new headers (vs the standard Parameters, Returns, Examples, Notes). Traditionally a lot of this type of description has gone at the top of files in a large docstring.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No change in behavior, just detailed documentation of the data layout on the format plus the output format of the DAC converter protocols output.