Qiskit / Qiskit/documentation

Cleanup: adjust punctuation when it could affect translation

Open
#4,789 0 comments 2 reactions 1 assignee View on GitHub

@beckykd is already working on this.

Since Sep 15, 2026.

content 📄
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

punctuation (specifically , : ; .) can create problems with translation when they are included inside a mathematical expression or a hyperlink. Move these punctuation marks outside the parens. EXCEPTIONS: do not change the punctuation in the case of an image (a line that begins with !), nor inside a math block (which uses $$).

I've done most of the instances in guides but will need to check again (some files were in progress during that work so I skipped till they were finalized). Still to do are files in learning/ and tutorials/

I think this is the regex string I searched with:

[.,;:][\]}\$]

Related to https://github.com/Qiskit/documentation/issues/4749

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.