Fix API generation regression #899
Merged
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
arnaucasau
changed the title
|
Thanks for contributing to Qiskit documentation! Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌 |
frankharkins
approved these changes
Feb 28, 2024
Eric-Arellano
approved these changes
Feb 28, 2024
Comment on lines
-234
to
236
| ### DEFAULT\_CONFIGURATION = \{'backend\_name' | ||
|
|
||
| `= {'backend_name':` | ||
| ### DEFAULT\_CONFIGURATION | ||
|
|
||
| `= {'backend_name': 'qasm_simulator', 'backend_version': '2.1.0', 'basis_gates': ['u1', 'u2', 'u3', 'rz', 'sx', 'x', 'cx', 'id', 'unitary'], 'conditional': True, 'coupling_map': None, 'description': 'A python simulator for qasm experiments', 'gates': [{'name': 'u1', 'parameters': ['lambda'], 'qasm_def': 'gate u1(lambda) q { U(0,0,lambda) q; }'}, {'name': 'u2', 'parameters': ['phi', 'lambda'], 'qasm_def': 'gate u2(phi,lambda) q { U(pi/2,phi,lambda) q; }'}, {'name': 'u3', 'parameters': ['theta', 'phi', 'lambda'], 'qasm_def': 'gate u3(theta,phi,lambda) q { U(theta,phi,lambda) q; }'}, {'name': 'rz', 'parameters': ['phi'], 'qasm_def': 'gate rz(phi) q { U(0,0,phi) q; }'}, {'name': 'sx', 'parameters': [], 'qasm_def': 'gate sx(phi) q { U(pi/2,7*pi/2,pi/2) q; }'}, {'name': 'x', 'parameters': [], 'qasm_def': 'gate x q { U(pi,7*pi/2,pi/2) q; }'}, {'name': 'cx', 'parameters': [], 'qasm_def': 'gate cx c,t { CX c,t; }'}, {'name': 'id', 'parameters': [], 'qasm_def': 'gate id a { U(0,0,0) a; }'}, {'name': 'unitary', 'parameters': ['matrix'], 'qasm_def': 'unitary(matrix) q1, q2,...'}], 'local': True, 'max_shots': 65536, 'memory': True, 'n_qubits': 24, 'open_pulse': False, 'simulator': True, 'url': 'https://github.com/Qiskit/qiskit-terra'}` |
There was a problem hiding this comment.
I was wondering if we should go back to the qiskit.org style of the default value being on the same line as the attribute. But this example makes it clear that that won't work. The default value and type hint might be way too long.
| @@ -216,9 +216,7 @@ Expanded Pass manager stages including `pre_` and `post_` phases. | |||
|
|
|||
| <span id="qiskit.transpiler.StagedPassManager.invalid_stage_regex" /> | |||
|
|
|||
| ### invalid\_stage\_regex = re.compile('\\\s|\\\\+|\\\\-|\\\\\*|\\\\/|\\\\\\\\|\\\\%|\\\\\<|\\\\>|\\\\@|\\\\!|\\\\\~|\\\\^|\\\\&|\\\\ | |||
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#224 This PR fixes an issue with the API generation script that causes regressions in attributes. For each attribute, we show on the documentation website, its type (if exists) and its default value (if exists). An example of an attribute could be `instance: str | None = None` which has the type `str | None` and the default value `None`. This is its representation on the website:  To find the attribute and the default value, the script searches for the index of the colon (type separator) and the index of the equal sign (default value separator). The problem is that those two values are optional, and we could have, for example, a default value involving a string containing a colon symbol that would be detected as the type separator when it's not. To fix this, we could only search for the type separator before the default value. We don't have any problem with the equal sign because it cannot be a type of attribute. The PR has regenerated all versions of qiskit, runtime, and provider.
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.
Closes #224
This PR fixes an issue with the API generation script that causes regressions in attributes. For each attribute, we show on the documentation website, its type (if exists) and its default value (if exists).
An example of an attribute could be
instance: str | None = Nonewhich has the typestr | Noneand the default valueNone. This is its representation on the website:To find the attribute and the default value, the script searches for the index of the colon (type separator) and the index of the equal sign (default value separator). The problem is that those two values are optional, and we could have, for example, a default value involving a string containing a colon symbol that would be detected as the type separator when it's not.
To fix this, we could only search for the type separator before the default value. We don't have any problem with the equal sign because it cannot be a type of attribute.
The PR has regenerated all versions of qiskit, runtime, and provider.