Fix a docstring rst link rendering within an inline literal #13567
Conversation
This file contains 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
|
One or more of the following people are relevant to this code:
|
Pull Request Test Coverage Report for Build 12351089492Details
💛 - Coveralls |
ElePT
reviewed
Dec 16, 2024
| @@ -725,7 +725,7 @@ def operation_names(self): | |||
|
|
|||
| @property | |||
| def instructions(self): | |||
| """Get the list of tuples ``(:class:`~qiskit.circuit.Instruction`, (qargs))`` | |||
| """Get the list of tuples (:class:`~qiskit.circuit.Instruction`, (qargs)) | |||
There was a problem hiding this comment.
Thanks for addressing this! What do you think of maintaining the code formatting for the rest of the tuple? It would look like this:
Suggested change
| """Get the list of tuples (:class:`~qiskit.circuit.Instruction`, (qargs)) | |
| """Get the list of tuples ``(``:class:`~qiskit.circuit.Instruction` ``, (qargs))`` |
It's not perfect but I find it a bit easier to read, probably personal choice.
There was a problem hiding this comment.
Bikeshedding alert :-) before I opened the PR we had a little poll (of 3) here at the lab which included your suggestion and the applied fix was chosen unanimously. Personally I find it slightly cleaner visually.
There was a problem hiding this comment.
ok, I am not to stand against unanimous votes. This change also looks good :)
ElePT
added
documentation
ElePT
approved these changes
Dec 16, 2024
mergify bot
pushed a commit
that referenced
this pull request
Dec 16, 2024
(cherry picked from commit 40aa70c)
github-merge-queue bot
pushed a commit
that referenced
this pull request
Dec 16, 2024
…13572) (cherry picked from commit 40aa70c) Co-authored-by: Eli Arbel <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changing from this:
to this:
If someone knows if there is a way to properly render an rst link within an inline literal text, I'd love to know.