update notebook convention result value#1623
Open
classiqdor wants to merge 4 commits into
Open
Conversation
classiqdor
commented
Jun 25, 2026
classiqdor
commented
Contributor
- Use result_value() instead of result()[0].value
- Add notebook-uniformity pre-commit (plural References)
- Enforce result_value() in notebook-uniformity hook
- Enforce show(qprog) over qprog.show() in notebook-uniformity hook
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
New auto-fixing hook .internal/pre_commit_tools/notebook_uniformity.py, wired into .pre-commit-config.yaml as 'notebook-uniformity'. First rule: a references heading must be plural ('References'). Auto-fixed the 11 existing notebooks with a singular heading.
Second rule for the notebook-uniformity hook: auto-fix .result()[0].value to .result_value() in code cells (only index [0], which is the safe equivalent). The repo is already clean, so this just guards against regressions.
Third rule: auto-fix the qprog.show() method form to show(qprog) in code cells, scoped to circuit vars (qprog*/quantum_program*/qp) so matplotlib's plt.show() is never touched. Fixed the one offender (hw_aware_synthesis).
classiqdor
force-pushed
the
update_notebook_convention__result_value
branch
from
32f0556 to
c2ba4d1
Compare
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
1 participant
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.