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

Fix incorrect TeX #11599

Merged
merged 3 commits into from
Jan 22, 2024
Merged

Fix incorrect TeX #11599

merged 3 commits into from
Jan 22, 2024

Conversation

kevinsung
Copy link
Contributor

Summary

These bugs broke the internal docs build; see Qiskit/documentation#635.

Details and comments

  • Incorrect omission of align environments.
  • Underscores not escaped
  • mbox not defined
  • A few other issues

@qiskit-bot
Copy link
Collaborator

One or more of the the following people are requested to review this:

  • @Cryoris
  • @Qiskit/terra-core
  • @ajavadia
  • @ikkoham
  • @nkanazawa1989

@coveralls
Copy link

coveralls commented Jan 19, 2024

Pull Request Test Coverage Report for Build 7613582066

Warning: This coverage report may be inaccurate.

We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
To ensure accuracy in future PRs, please see these guidelines.
A quick fix for this PR: rebase it; your next report should be accurate.

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.003%) to 89.508%

Totals Coverage Status
Change from base Build 7584386082: 0.003%
Covered Lines: 59479
Relevant Lines: 66451

💛 - Coveralls

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 these fixes. My only question is about the inner environment choice - if the .. math:: already counts as a displaymode entry, then I'd expect the best environment inside it to be aligned, but if the backend wants the duplicated specification of displaymode, then fine.

qiskit/pulse/library/symbolic_pulses.py Outdated Show resolved Hide resolved
@Eric-Arellano Eric-Arellano added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Jan 19, 2024
@Eric-Arellano Eric-Arellano added this to the 0.45.2 milestone Jan 19, 2024
@Eric-Arellano Eric-Arellano added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Jan 19, 2024
@jakelishman jakelishman removed this from the 0.45.2 milestone Jan 19, 2024
@jakelishman
Copy link
Member

0.45.2 is already released, so the milestone should have already been closed. We're not planning a 0.45.3 release, but assuming the documentation is decoupled from actual PyPI releases, we can still backport this to stable/0.45.

The CI failure was unrelated and fixed on main.

@Eric-Arellano
Copy link
Collaborator

We're not planning a 0.45.3 release, but assuming the documentation is decoupled from actual PyPI releases

Yep, we can build the docs from any CI artifact. So we only need it backported to stable/0.45.

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.

Nice, thanks!

@jakelishman jakelishman added this pull request to the merge queue Jan 22, 2024
Merged via the queue into Qiskit:main with commit 30bf727 Jan 22, 2024
12 checks passed
mergify bot pushed a commit that referenced this pull request Jan 22, 2024
* fix tex

* use aligned instead of align*

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
(cherry picked from commit 30bf727)

# Conflicts:
#	qiskit/pulse/library/symbolic_pulses.py
@kevinsung kevinsung deleted the fix-tex branch January 22, 2024 18:52
github-merge-queue bot pushed a commit that referenced this pull request Jan 22, 2024
* Fix incorrect TeX (#11599)

* fix tex

* use aligned instead of align*

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
(cherry picked from commit 30bf727)

# Conflicts:
#	qiskit/pulse/library/symbolic_pulses.py

* Fix merge conflict

---------

Co-authored-by: Kevin J. Sung <kevjsung@umich.edu>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
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 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
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants