Skip to content

Ajc/docs updates - #170

Merged
garrison merged 6 commits into
Qiskit:mainfrom
abbycross:ajc/docs-updates
Jun 3, 2026
Merged

Ajc/docs updates#170
garrison merged 6 commits into
Qiskit:mainfrom
abbycross:ajc/docs-updates

Conversation

@abbycross

Copy link
Copy Markdown
Contributor

Docs edits in preparation for publication on IBM Quantum Platform.

To review: @garrison @jenglick

@coveralls

coveralls commented May 15, 2026

Copy link
Copy Markdown

Coverage Report for CI Build 26527546406

Coverage remained the same at 100.0%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 669
Covered Lines: 669
Line Coverage: 100.0%
Coverage Strength: 1.0 hits per line

💛 - Coveralls

@garrison garrison added the documentation Improvements or additions to documentation label May 15, 2026
@garrison
garrison requested review from garrison and jenglick May 15, 2026 21:14
Comment thread docs/index.rst

It has been tested primarily on Trotter circuits to date. It might, however, be applicable to any class of circuits where you have access to both of the following:

- A *great* intermediate state, known as the "target state," that can be achieved by tensor-network simulation

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Was this intentional? The style guide does not seem to address this, but it does seem to order quotations and punctuation in the American style. For instance:

"The Estimator primitive returns a list of values."
[...]
"that is," "for example," "and so on," or "versus"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We have an annoying thing with our translation pipeline that sometimes has trouble with punctuation inside quotation marks, parens, brackets, etc - it ignores what is inside and then adds extra punctuation outside, which then breaks and requires manual fixing during the deploy. It's a definite gotcha with parens but only occasionally with quotation marks, so I'm happy to leave it as-is and see how it behaves.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for the clarification.

@garrison
garrison merged commit 6a3f264 into Qiskit:main Jun 3, 2026
23 checks passed
garrison pushed a commit that referenced this pull request Jun 3, 2026
* Update index.rst

* Update 01_quimb_tnoptimizer.ipynb

* Update index.rst

* Update INSTALL.rst

* Update index.rst

* restore toctree, set to hidden

(cherry picked from commit 6a3f264)

Co-authored-by: abbycross <across@us.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation stable backport potential

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants