Skip to content
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
merged 40 commits into from
Aug 16, 2021

Conversation

jenshnielsen
Copy link
Collaborator

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

Screenshot 2021-07-23 140750

In the longer term this can be improved to more nicely format the repr using autodoc-process-docstring or autodoc-process-signature

This pr replaces #3188

@jenshnielsen jenshnielsen marked this pull request as draft July 23, 2021 12:10
@jenshnielsen
Copy link
Collaborator Author

Needs some further test and the parser code should be made a bit more robust

@codecov
Copy link

codecov bot commented Jul 23, 2021

Codecov Report

Merging #3224 (0c2e051) into master (45f7471) will increase coverage by 0.06%.
The diff coverage is 81.98%.

@@            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 jenshnielsen force-pushed the docs_document_properties branch 3 times, most recently from d71ce68 to 3077c16 Compare August 11, 2021 09:48
@jenshnielsen jenshnielsen marked this pull request as ready for review August 11, 2021 14:56
@jenshnielsen
Copy link
Collaborator Author

@trevormorgan can you have a look?

@jenshnielsen jenshnielsen added this to the 0.28.0 milestone Aug 11, 2021
Copy link
Contributor

@trevormorgan trevormorgan left a 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.

@jenshnielsen jenshnielsen merged commit 9a1fdd3 into microsoft:master Aug 16, 2021
@jenshnielsen jenshnielsen deleted the docs_document_properties branch August 16, 2021 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants