Fix from_diagram docstring on GridQubit. #5307
Merged
Conversation
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
MichaelBroughton
requested review from
a team,
vtomole and
cduck
as code owners
95-martin-orion
requested changes
Apr 29, 2022
cirq-core/cirq/devices/grid_qubit.py
Outdated
| ---A--- | ||
| --AAA-- | ||
| -AAAAA- | ||
| AAAAAAA | ||
| ``` | ||
|
|
||
| You can use any character other than a hyphen to mark a qid. As an |
There was a problem hiding this comment.
This is incorrect, as noted in the "Args: diagram" section below. Periods and spaces are also treated as non-Qid positions, and non-alphanumeric characters produce an error.
cirq-core/cirq/devices/grid_qubit.py
Outdated
|
|
||
| Args: | ||
| diagram: String representing the qid layout. Each line represents | ||
| a row. Alphanumeric characters are assigned as qid. | ||
| Dots ('.'), dashes ('-'), and spaces (' ') are treated as | ||
| Dots ('.'), dashes ('-'), and spaces are treated as |
There was a problem hiding this comment.
Why drop the (' ')? I think it's helpful just for clarifying that we mean the "space" character, not whitespace in general.
95-martin-orion
requested changes
Jun 1, 2022
95-martin-orion
approved these changes
Jun 1, 2022
95-martin-orion
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
CirqBot
removed
automerge
rht
pushed a commit
to rht/Cirq
that referenced
this pull request
May 1, 2023
Fixes broken docstring for `from_diagram` on gridqubit page.
harry-phasecraft
pushed a commit
to PhaseCraft/Cirq
that referenced
this pull request
Oct 31, 2024
Fixes broken docstring for `from_diagram` on gridqubit page.
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.
Fixes broken docstring for
from_diagramon gridqubit page.