-
Notifications
You must be signed in to change notification settings - Fork 154
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
Use attribute docstrings for options #1897
base: main
Are you sure you want to change the base?
Conversation
sequence_type: Union[UnsetType, Literal["XX", "XpXm", "XY4"]] = Unset | ||
r"""Which dynamical decoupling sequence to use. Default: "XX". |
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.
default?
I think a bunch of them are missing, so check the other docstrings
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.
I need to double check these all render correctly too
|
||
Default: 1. | ||
If twirling is enabled, the value of this option will be divided over circuit, |
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.
"divided over circuit, randomizations," reads oddly to me but maybe it is codespeak?
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Co-authored-by: abbycross <[email protected]>
Summary
Details and comments
Fixes #1762