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

Docstring only: Fix math parsing error for Pauli docstring #11238

Merged
merged 2 commits into from
Nov 14, 2023

Conversation

grossardt
Copy link
Contributor

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.)

@grossardt grossardt requested review from ikkoham and a team as code owners November 14, 2023 15:59
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Nov 14, 2023
@qiskit-bot
Copy link
Collaborator

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:

  • @Qiskit/terra-core
  • @ikkoham

Copy link
Member

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

@jakelishman jakelishman added documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable Changelog: None Do not include in changelog labels Nov 14, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 6866194577

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 5 unchanged lines in 1 file lost coverage.
  • Overall coverage remained the same at 85.928%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 5 91.92%
Totals Coverage Status
Change from base Build 6865596785: 0.0%
Covered Lines: 65938
Relevant Lines: 76736

💛 - Coveralls

@jakelishman jakelishman added this pull request to the merge queue Nov 14, 2023
Merged via the queue into Qiskit:main with commit d418d8e Nov 14, 2023
13 checks passed
mergify bot pushed a commit that referenced this pull request Nov 14, 2023
@grossardt grossardt deleted the doc-fix-typos-pauli branch November 14, 2023 20:12
github-merge-queue bot pushed a commit that referenced this pull request Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog Community PR PRs from contributors that are not 'members' of the Qiskit repo documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants