Add user best practices documentation #5604
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
- Add document under 'start' about some basic best practices, like using 'cirq.X' instead of 'cirq.ops.X'. - Also added sections about immutability of gates, operations, and parameter resolvers. - Removed name of former product manager.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
FYI: test failure is a complex64 related flake |
augustehirth
approved these changes
Jun 24, 2022
vtomole
reviewed
Jun 24, 2022
docs/start/best_practices.md
Outdated
| `cirq.ParamResolver` should not be modified after creation. If these objects | ||
| need to be modified, a new object should be created instead. | ||
|
|
||
| Violating this priniciple could cause problems in other parts of the code. For |
There was a problem hiding this comment.
Suggested change
| Violating this priniciple could cause problems in other parts of the code. For | |
| Violating this principle could cause problems in other parts of the code. For |
Make `git diff --check master` happy.
Co-authored-by: Victory Omole <[email protected]>
Co-authored-by: Victory Omole <[email protected]>
Co-authored-by: Victory Omole <[email protected]>
|
@vtomole Hmmm... looks like there is some problem with your CLA that is now blocking the PR since I took your suggestions. |
|
LGTM. There is also a best_practices.ipynb notebook, |
pavoljuhas
approved these changes
Jun 24, 2022
Oh that's very new. Lemme look if i changed my default email. |
vtomole
approved these changes
Jun 24, 2022
dstrain115
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
- Add document under 'start' about some basic best practices, like using 'cirq.X' instead of 'cirq.ops.X'. - Also added sections about immutability of gates, operations, and parameter resolvers. - Removed name of former product manager. Fixes: quantumlib#1373
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.
like using 'cirq.X' instead of 'cirq.ops.X'.
parameter resolvers.
Fixes: #1373