Qiskit / qiskit-fermions / 32736540825
98%
main: 98%

LAST BUILD BRANCH: memory-jw
DEFAULT BRANCH: main
Ran
Jobs 1
Files 103
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 98.021%. Remained the same
32736540825

push

github

web-flow 
More IBM style-guide confirmance edits (#288) (#293)

* docs: replace Latin abbreviations with plain English

The IBM Quantum style guide bans Latin abbreviations outright ("Do not use
Latin abbreviations i.e., e.g., etc., and vs."), because they are hard to
translate and are not universally understood. PR #281 copyedited every guide
against that style guide but left these untouched, so close the gap.

"e.g." in sqdrift.rst followed a comma splice, so it becomes a new sentence
rather than a drop-in substitution.

Occurrences inside code comments and Jinja template comments are deliberately
left alone: #281 confined itself to prose, and so does this.



* docs: replace "may" with "can" or "might"

The IBM Quantum style guide bans "may" ("Do not use 'may'") because it
conflates permission with possibility, which makes it ambiguous to read and to
translate. PR #281 did not cover this, and it never reached the C API reference
pages or the Rust docstrings at all.

The distinction drives the replacement: "You may access read-only copies" is
permission, so it becomes "can"; everything else expresses possibility and
becomes "might".

The pyext and cext docstrings are edited alongside docs/cdoc/*.rst because the
three surfaces carry the same sentences, and letting them drift would be worse
than leaving them all wrong.

Apache license headers ("You may obtain a copy of this license") are untouched:
that is verbatim legal boilerplate, not our prose.

The committed .pyi stubs are regenerated accordingly (`make pystubs-dev`), so
`make lint`'s pystubs-check stays green.



* docs: stop letting the software grant permission

The IBM Quantum style guide rejects anthropomorphism and phrasing in which a
product grants the reader permission ("X lets you / allows you / enables you
to..."), preferring the user-focused "you can use X to...". PR #281 left these
in place.

Recast each so the capability belongs to the reader rather than to the library,
and replace the one ins... (continued)

12087 of 12331 relevant lines covered (98.02%)

528177.85 hits per line

Jobs
ID Job ID Ran Files Coverage
1 32736540825.1 103
98.02
 GitHub Action Run
Source Files on build 32736540825