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

Add Python standard library to Intersphinx mapping #10523

Merged
merged 2 commits into from
Aug 14, 2023

Conversation

jakelishman
Copy link
Member

Summary

This is good for the resolution of just over 200 failed Sphinx references, almost all of which are from Sphinx attempting to insert links in type hints. Those aren't super important, but it's nice in the vein of being able to use Sphinx's nitpicky mode to find places where we have Sphinx references that are failing to resolve, since it silences some of the noise.

Details and comments

Similar to #10522, this is me idly trying to reduce our number of failed Sphinx lookups with a very approximate goal of being able to turn on Sphinx's nitpicky mode, since it seems to me like the Terra release manager spends a lot of time trying to verify that all the documentation links in the release nodes actually work. That seems like a giant waste of everyone's time and something that ought to be automatically enforced, if it's not too much of a pain.

This is good for the resolution of just over 200 failed Sphinx
references, almost all of which are from Sphinx attempting to insert
links in type hints.  Those aren't super important, but it's nice in the
vein of being able to use Sphinx's `nitpicky` mode to find places where
we have Sphinx references that are failing to resolve, since it silences
some of the noise.
@jakelishman jakelishman added 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 Changelog: None Do not include in changelog labels Jul 28, 2023
@jakelishman jakelishman requested a review from a team as a code owner July 28, 2023 11:36
@qiskit-bot
Copy link
Collaborator

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

@mtreinish mtreinish added this to the 0.25.1 milestone Jul 28, 2023
@coveralls
Copy link

coveralls commented Jul 28, 2023

Pull Request Test Coverage Report for Build 5837176497

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 19 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-0.01%) to 87.246%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 1 91.9%
crates/qasm2/src/parse.rs 18 96.67%
Totals Coverage Status
Change from base Build 5836645682: -0.01%
Covered Lines: 74278
Relevant Lines: 85136

💛 - Coveralls

@mtreinish mtreinish added this pull request to the merge queue Aug 14, 2023
Merged via the queue into Qiskit:main with commit b3b59e9 Aug 14, 2023
14 checks passed
mergify bot pushed a commit that referenced this pull request Aug 14, 2023
This is good for the resolution of just over 200 failed Sphinx
references, almost all of which are from Sphinx attempting to insert
links in type hints.  Those aren't super important, but it's nice in the
vein of being able to use Sphinx's `nitpicky` mode to find places where
we have Sphinx references that are failing to resolve, since it silences
some of the noise.

(cherry picked from commit b3b59e9)
github-merge-queue bot pushed a commit that referenced this pull request Aug 15, 2023
This is good for the resolution of just over 200 failed Sphinx
references, almost all of which are from Sphinx attempting to insert
links in type hints.  Those aren't super important, but it's nice in the
vein of being able to use Sphinx's `nitpicky` mode to find places where
we have Sphinx references that are failing to resolve, since it silences
some of the noise.

(cherry picked from commit b3b59e9)

Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
jaeunkim pushed a commit to jaeunkim/qiskit-terra that referenced this pull request Aug 15, 2023
This is good for the resolution of just over 200 failed Sphinx
references, almost all of which are from Sphinx attempting to insert
links in type hints.  Those aren't super important, but it's nice in the
vein of being able to use Sphinx's `nitpicky` mode to find places where
we have Sphinx references that are failing to resolve, since it silences
some of the noise.
@jakelishman jakelishman deleted the python-stdlib-intersphinx branch August 31, 2023 10:45
SamD-1998 pushed a commit to SamD-1998/qiskit-terra that referenced this pull request Sep 7, 2023
This is good for the resolution of just over 200 failed Sphinx
references, almost all of which are from Sphinx attempting to insert
links in type hints.  Those aren't super important, but it's nice in the
vein of being able to use Sphinx's `nitpicky` mode to find places where
we have Sphinx references that are failing to resolve, since it silences
some of the noise.
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