-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Docstring only: Fix math parsing error for Pauli docstring #11238
Conversation
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
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.
Thanks for the fix.
It's not a Sphinx bug so much as a documented part of rST. Roles (the `...`
bit) need to be followed by a non-word character. Using -
like here is ok, as would be using an explicit escape (":math:`k`\\ th"
or r":math:`k`\ th"
as appropriate).
Pull Request Test Coverage Report for Build 6866194577
💛 - Coveralls |
(cherry picked from commit d418d8e)
(cherry picked from commit d418d8e) Co-authored-by: André <[email protected]>
Summary
:math:`k`th
in docstring (or generally math directly followed by a letter) results in parsing error, see qiskit.quantum_info.Pauli under section 'Array Representation'. Assuming this is a Sphinx bug, but as a simple fix replaced by:math:`k`-th
. (:class:qiskit.quantum_info.Pauli
seems the only place where this issue occurs.)(Since this is a simple typo fix in the docstring only, I directly opened the PR without filing a bug report first and without adding release notes. Please let me know if this is improper procedure.)