Update and make minor additions to docs/ in time for Cirq 1.5 #7175
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7175 +/- ##
==========================================
- Coverage 98.14% 98.14% -0.01%
==========================================
Files 1100 1100
Lines 96191 96147 -44
==========================================
- Hits 94409 94365 -44
Misses 1782 1782 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
It seems like the Docker container may not be used solely for the Rigetti module, so I left the other text about Docker and only removed the statement involving Rigetti.
This entire section still needs a good re-think and more revisions. For now, I just removed mention of the labels that have been changed.
It's true that the section on what's covered mentioned that vendor modules are not, but it seemed strange that it was not mentioned in the section that is specifically about what's no covered.
Mostly fix capitalization and occasional missing hyphens.
Putting the bullet item about hardware modules seems higher in the list seems like it's better, so that the flow of concepts goes somewhare more general to somewhat more specific.
Changes: * There were 3 H1 headings, and at the same time, the first heading did not match what is in the TOC. I changed this to have one H1 heading that matches the TOC text, made the remaining headings H2, and added a lead-in paragaraph * Rewrote the section about using the issue tracker in attempt to be more specific and clear. * Added a section about using the Q.C. Stack Exchange. * Added a section about using email to contact us.
A trivial change to match the way other headings were written.
Removed more no-longer-existing issue labels, and rewrote section on stale issue/PR heading to be more succinct.
It has no Cirq interface, and it's a bit too early stage still.
It's not essential, and removing it now will help reduce the number of places we have to update when we remove Rigetti altogether.
This adds information about `isort`'s use in Cirq, now that PR quantumlib#7181 has been merged and `isort` is used in the check/ scripts.
pavoljuhas
approved these changes
Mar 28, 2025
Thanks for that correction. |
This was referenced May 30, 2025
BichengYing
pushed a commit
to BichengYing/Cirq
that referenced
this pull request
Jun 20, 2025
…mlib#7175) * Add citation for Tesseract Decoder * Add Tesseract Decoder & remove Rigetti * Remove statement about cirq-rigetti It seems like the Docker container may not be used solely for the Rigetti module, so I left the other text about Docker and only removed the statement involving Rigetti. * Add mention of Tesseract & fix a couple of tiny niggles * Remove mention of labels no longer used This entire section still needs a good re-think and more revisions. For now, I just removed mention of the labels that have been changed. * Repeat the statement about vendor modules It's true that the section on what's covered mentioned that vendor modules are not, but it seemed strange that it was not mentioned in the section that is specifically about what's no covered. * Edit for typos Mostly fix capitalization and occasional missing hyphens. * Add notices that cirq-rigetti is deprecated * Small edits for grammar and clarity * Move paragraph about hardware modules higher in the list Putting the bullet item about hardware modules seems higher in the list seems like it's better, so that the flow of concepts goes somewhare more general to somewhat more specific. * Trivial edits to rewrite a phrase & add formatting * Fix trivial typos * Partially rewrite support.md Changes: * There were 3 H1 headings, and at the same time, the first heading did not match what is in the TOC. I changed this to have one H1 heading that matches the TOC text, made the remaining headings H2, and added a lead-in paragaraph * Rewrote the section about using the issue tracker in attempt to be more specific and clear. * Added a section about using the Q.C. Stack Exchange. * Added a section about using email to contact us. * Fix minor inconsistent heading content style A trivial change to match the way other headings were written. * Update triage description Removed more no-longer-existing issue labels, and rewrote section on stale issue/PR heading to be more succinct. * Fix trivial typos Capitalization and placement of colon characters. * Run spell checker * Fix a few more typos * Fix a few more tiny typos * Take out Tesseract for now It has no Cirq interface, and it's a bit too early stage still. * Update list of software * Spell out LBL and ORNL * Mildly edit another description * Fix misspelled name * Remove cirq-rigetti from list of example modules It's not essential, and removing it now will help reduce the number of places we have to update when we remove Rigetti altogether. * Make note of deprecation status in more places * Update the section on Python imports This adds information about `isort`'s use in Cirq, now that PR quantumlib#7181 has been merged and `isort` is used in the check/ scripts. * Fix typo * Shorten the import ordering section --------- Co-authored-by: Pavol Juhas <juhas@google.com>
This was referenced Aug 5, 2025
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.
Changes:
Removed mention of Rigetti from indexes and other places, but left docs/hardware/rigetti. The intention is to stop advertising it because it's being deprecated, but leave the docs so that people who still use it can find some documentation.
Added a statement at the top of all the files in docs/hardware/rigetti stating it's deprecated in this release.
In the versioning process document, clarified the backwards compatibility policy w.r.t. hardware vendor interface modules.
Added mention of new Tesseract Decoder project in a couple of relevant places.
Made updates to the triage process document.
Made updates to the tool ecosystem page.
Made updates to the support page with more info.
Fixed tiny typos, capitalization inconsistencies, missing hyphens, tiny formatting niggles like putting a few more things in
code face.