Improve docstrings for abstract hardware objects #1116
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
fabcor-maxiv
force-pushed
the
abstract-hwo-docstrings
branch
from
f0791da to
eba2843
Compare
|
Nice, good initiative ! |
fabcor-maxiv
force-pushed
the
abstract-hwo-docstrings
branch
from
eba2843 to
5ba1f68
Compare
|
Just now we are being hit by this deprecation: https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/. :D |
|
Yeah I noticed as well, its not our week for documentation :) |
fabcor-maxiv
force-pushed
the
abstract-hwo-docstrings
branch
2 times, most recently
from
5090b37 to
4a7ccc3
Compare
|
If you re-base Ill merge :) |
General improvements to the docstrings of abstract hardware objects: * Add an `Emits` custom section for Sphinx's Napoleon extension * Fix docstrings formatting * Document some emitted signals * Move types from docstring to type hints when possible * Som formatting with `black` GitHub: supersedes mxcube#866 GitHub: supersedes mxcube#947
fabcor-maxiv
force-pushed
the
abstract-hwo-docstrings
branch
from
4a7ccc3 to
bb80298
Compare
This was referenced Jan 31, 2025
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.
General improvements to the docstrings of abstract hardware objects:
Emitscustom section for Sphinx's Napoleon extensionblackGitHub: supersedes #866
GitHub: supersedes #947