Fix broken documentation references in qiskit.providers#10547
Merged
Conversation
This fixes all the broken crossreferences in the Sphinx build of `qiskit.providers`, found by using Sphinx's nitpicky mode. Leaving aside the errors due to attempted crossreferences to Python builtin and standard-library types (which are fixed in another commit), there were just over 500 errors in this module (the count inflated severely because of docstring inheritance) which are now all fixed.
jakelishman
added
documentation
Collaborator
|
One or more of the the following people are requested to review this:
|
mtreinish
reviewed
Aug 2, 2023
jakelishman
commented
Aug 2, 2023
Comment on lines
86
to
87
|
|
||
| class Gate: | ||
| class GateProperties: | ||
| """Class representing a gate's properties |
Member
Author
There was a problem hiding this comment.
I renamed this (and put in a backwards-compatibility alias below) to avoid introducing an annoying Sphinx conflict in the crossreference :class:`.Gate` with qiskit.circuit.Gate.
Pull Request Test Coverage Report for Build 5741091114
💛 - Coveralls |
Eric-Arellano
previously approved these changes
Aug 30, 2023
Contributor
Eric-Arellano
left a comment
Eric-Arellano
left a comment
There was a problem hiding this comment.
Thanks for improving this!
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
1ucian0
approved these changes
Aug 31, 2023
SameerD-phys
pushed a commit
to SameerD-phys/qiskit-terra
that referenced
this pull request
Sep 7, 2023
* Fix broken documentation references in `qiskit.providers` This fixes all the broken crossreferences in the Sphinx build of `qiskit.providers`, found by using Sphinx's nitpicky mode. Leaving aside the errors due to attempted crossreferences to Python builtin and standard-library types (which are fixed in another commit), there were just over 500 errors in this module (the count inflated severely because of docstring inheritance) which are now all fixed. * Remove unneeded reference to base type * Fix broken import * Update qiskit/providers/backend.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
ElePT
pushed a commit
to ElePT/qiskit-ibm-provider
that referenced
this pull request
Oct 4, 2023
…kit#10547) * Fix broken documentation references in `qiskit.providers` This fixes all the broken crossreferences in the Sphinx build of `qiskit.providers`, found by using Sphinx's nitpicky mode. Leaving aside the errors due to attempted crossreferences to Python builtin and standard-library types (which are fixed in another commit), there were just over 500 errors in this module (the count inflated severely because of docstring inheritance) which are now all fixed. * Remove unneeded reference to base type * Fix broken import * Update qiskit/providers/backend.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
ElePT
pushed a commit
to ElePT/qiskit-ibm-runtime
that referenced
this pull request
Oct 10, 2023
…kit#10547) * Fix broken documentation references in `qiskit.providers` This fixes all the broken crossreferences in the Sphinx build of `qiskit.providers`, found by using Sphinx's nitpicky mode. Leaving aside the errors due to attempted crossreferences to Python builtin and standard-library types (which are fixed in another commit), there were just over 500 errors in this module (the count inflated severely because of docstring inheritance) which are now all fixed. * Remove unneeded reference to base type * Fix broken import * Update qiskit/providers/backend.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
ElePT
pushed a commit
to ElePT/qiskit
that referenced
this pull request
Oct 12, 2023
* Fix broken documentation references in `qiskit.providers` This fixes all the broken crossreferences in the Sphinx build of `qiskit.providers`, found by using Sphinx's nitpicky mode. Leaving aside the errors due to attempted crossreferences to Python builtin and standard-library types (which are fixed in another commit), there were just over 500 errors in this module (the count inflated severely because of docstring inheritance) which are now all fixed. * Remove unneeded reference to base type * Fix broken import * Update qiskit/providers/backend.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
ElePT
pushed a commit
to ElePT/qiskit-ibm-runtime
that referenced
this pull request
Dec 8, 2023
…kit#10547) * Fix broken documentation references in `qiskit.providers` This fixes all the broken crossreferences in the Sphinx build of `qiskit.providers`, found by using Sphinx's nitpicky mode. Leaving aside the errors due to attempted crossreferences to Python builtin and standard-library types (which are fixed in another commit), there were just over 500 errors in this module (the count inflated severely because of docstring inheritance) which are now all fixed. * Remove unneeded reference to base type * Fix broken import * Update qiskit/providers/backend.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This fixes all the broken crossreferences in the Sphinx build of
qiskit.providers, found by using Sphinx's nitpicky mode. Leaving aside the errors due to attempted crossreferences to Python builtin and standard-library types (which are fixed in another commit), there were just over 500 errors in this module (the count inflated severely because of docstring inheritance) which are now all fixed.Details and comments
The "other commit" alluded to in the message that fixes the builtin/standard-library types is #10523, but this PR doesn't depend on that one.