-
Notifications
You must be signed in to change notification settings - Fork 301
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
Document Parameter attributes #3224
Merged
jenshnielsen
merged 40 commits into
microsoft:master
from
jenshnielsen:docs_document_properties
Aug 16, 2021
Merged
Document Parameter attributes #3224
jenshnielsen
merged 40 commits into
microsoft:master
from
jenshnielsen:docs_document_properties
Aug 16, 2021
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
Needs some further test and the parser code should be made a bit more robust |
Codecov Report
@@ Coverage Diff @@
## master #3224 +/- ##
==========================================
+ Coverage 66.03% 66.09% +0.06%
==========================================
Files 219 220 +1
Lines 29041 29150 +109
==========================================
+ Hits 19177 19267 +90
- Misses 9864 9883 +19 |
jenshnielsen
force-pushed
the
docs_document_properties
branch
3 times, most recently
from
August 11, 2021 09:48
d71ce68
to
3077c16
Compare
@trevormorgan can you have a look? |
jenshnielsen
commented
Aug 12, 2021
jenshnielsen
force-pushed
the
docs_document_properties
branch
from
August 12, 2021 13:31
d81fb38
to
371fddd
Compare
trevormorgan
approved these changes
Aug 16, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR looks really solid to me, just a few comments from my end.
and port two drivers to match the new parameter registration
in which case the code is the last node
object does not for examble have code
jenshnielsen
force-pushed
the
docs_document_properties
branch
from
August 16, 2021 07:56
371fddd
to
17e7356
Compare
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.
This adds a Sphinx extension that documents parameter attributes on instrument classes. There are documented using a proxy object that contains a
__repr__
that contains the code to construct the parameter class.As an example this is how the Wenishel looks on this class
In the longer term this can be improved to more nicely format the repr using
autodoc-process-docstring
orautodoc-process-signature
This pr replaces #3188