Add M and R aliases for cirq.measure and cirq.reset #5993
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
pavoljuhas
reviewed
Jan 31, 2023
| @@ -779,6 +780,10 @@ def reset(qubit: 'cirq.Qid') -> raw_types.Operation: | |||
| return ResetChannel(qubit.dimension).on(qubit) | |||
|
|
|||
|
|
|||
| R = reset | |||
| document(R, """Alias for cirq.reset""") | |||
There was a problem hiding this comment.
This overwrites the reset docstring here.
Perhaps we should just add a note about the R alias to the reset docstring?
There was a problem hiding this comment.
If we want references to cirq.M in the generated docs, we might need to create a wrapper function so it is a different object.
pavoljuhas
requested changes
Jan 31, 2023
|
Thanks, @pavoljuhas. I fixed the docstrings and added notes there about the new aliases. |
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 #5992