Skip to content

Fix several typos in tutorials#1422

Merged
mhucka merged 4 commits into
quantumlib:mainfrom
arettig:docs_typos
Jul 17, 2026
Merged

Fix several typos in tutorials#1422
mhucka merged 4 commits into
quantumlib:mainfrom
arettig:docs_typos

Conversation

@arettig

@arettig arettig commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Fixes several small typos in the OpenFermion tutorials. There were a couple issues parsing latex that were fixed:

  1. When an inline latex expression is split across several lines, it is not parsed correctly.
  2. For a displayed latex expression, if the equation is written across several lines (i.e. for readability reasons), if it is indented too much, markdown interprets it as a code block and splits the equation expression.

Fixes several small typos in the OpenFermion tutorials. The docs builder
cannot handle inline latex that is split across several lines, so these
were combined to a single line.
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates several tutorial notebooks to fix typos, improve grammar, add hyperlinks to arXiv references, and reformat equations. A review comment points out that the Bose-Hubbard Hamiltonian formula in bosonic_operators.ipynb contains mathematical and physical errors in its summation indices and hopping terms, and provides a corrected version matching the codebase implementation.

Comment thread docs/tutorials/bosonic_operators.ipynb Outdated
arettig added 2 commits July 16, 2026 21:11
The equation for the Bose-Hubbard Hamiltonian was incorrect due to some
sum bounds. 'V' was also used as both the dipole interaction strength and
the set of nodes in the model. These are both corrected here.
The previous equation that was broken into multiple lines got interpreted
as a code block because the -/+ signs at the start of the lines turned it
into a markdown list. Moving these to the end of the previous line fixes
the problem.
@arettig
arettig requested a review from mhucka July 16, 2026 22:39

@mhucka mhucka left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing these.

@mhucka mhucka added priority/before-1.8.1 area/docs Involves documentation, notebooks, README files, and similar labels Jul 16, 2026
@mhucka
mhucka enabled auto-merge July 16, 2026 22:48
@mhucka
mhucka disabled auto-merge July 17, 2026 01:30
@mhucka
mhucka merged commit 1b26f8c into quantumlib:main Jul 17, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Involves documentation, notebooks, README files, and similar priority/before-1.8.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants