Update and refresh cirq-* module README files#6900
Merged
pavoljuhas merged 20 commits intoquantumlib:mainfrom Feb 1, 2025
Merged
Update and refresh cirq-* module README files#6900pavoljuhas merged 20 commits intoquantumlib:mainfrom
pavoljuhas merged 20 commits intoquantumlib:mainfrom
Conversation
This updates all the cirq-* module files to fix some broken image links, spiff up the layout and formatting, and add some additional links here and there.
rstcheck complains about it.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6900 +/- ##
==========================================
- Coverage 97.89% 97.88% -0.01%
==========================================
Files 1085 1085
Lines 95131 95131
==========================================
- Hits 93127 93123 -4
- Misses 2004 2008 +4 ☔ View full report in Codecov by Sentry. |
mhucka
requested review from
a team,
ColemanCollins,
HGSilveri,
dabacon,
gmauricio,
ma5x,
nakardo,
pschindler,
verult,
vtomole and
wcourtney
as code owners
dstrain115
reviewed
Jan 14, 2025
pavoljuhas
requested changes
Jan 16, 2025
Collaborator
pavoljuhas
left a comment
pavoljuhas
left a comment
There was a problem hiding this comment.
LGTM with a couple of small suggestions - please see inline.
Thank you for improving these!
auto-merge was automatically disabled
January 28, 2025 18:52
Pull request was converted to draft
This updates all the cirq-* module files to fix some broken image links, spiff up the layout and formatting, and add some additional links here and there. As before, these remain purposefully short and fairly minimal because these are add-only modules to the main `cirq` distribution.
This matches the changes in the top-level `setup.py` file, to adapt them to use README.md instead of README.rst.
This updates the text about module purpose and access, and does miscellaneous fixes such as conforming to Google's Markdown style guidance.
It turns out that particular logo is strictly for use only on the QAI website. I want to find another, but right now that doesn't seem to be the best use of time, so let's just use only the Cirq logo and leave it for now.
pavoljuhas
approved these changes
Jan 30, 2025
Collaborator
There was a problem hiding this comment.
Looks great, thank you for improving these!
Please correct URLs in cirq-google README before merging.
Also, you may want to replace README.rst --> README.md in docs/dev/modules.md
Contributor
Author
I put that in the separate PR #7009. It could be argued that it would be better done in this PR. Should I move it here? |
Reported by @Pavol in review comment quantumlib#6900 (comment)
Per request by @Pavol in comment quantumlib#6900 (comment)
Collaborator
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
BichengYing
pushed a commit
to BichengYing/Cirq
that referenced
this pull request
Jun 20, 2025
* Update and refresh cirq-* module README files This updates all the cirq-* module files to fix some broken image links, spiff up the layout and formatting, and add some additional links here and there. * Remove unused hyperlink target definition rstcheck complains about it. * Clarify the access restrictions to the quantum computing service * Update & refresh cirq-*/README files & convert to md This updates all the cirq-* module files to fix some broken image links, spiff up the layout and formatting, and add some additional links here and there. As before, these remain purposefully short and fairly minimal because these are add-only modules to the main `cirq` distribution. * Update setup.py's for README.md & refreshed version warning This matches the changes in the top-level `setup.py` file, to adapt them to use README.md instead of README.rst. * Revise intro paragraphs and do misc. fix-ups This updates the text about module purpose and access, and does miscellaneous fixes such as conforming to Google's Markdown style guidance. * Remove "Google QAI" logo It turns out that particular logo is strictly for use only on the QAI website. I want to find another, but right now that doesn't seem to be the best use of time, so let's just use only the Cirq logo and leave it for now. * Fix incorrect links for access and getting started Reported by @Pavol in review comment quantumlib#6900 (comment) * Remove circled "i" symbol Per request by @Pavol in comment quantumlib#6900 (comment)
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
4 participants
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.
This updates all the cirq-* module files to fix some broken image links, spiff up the layout and formatting, and add some additional links here and there.
As before, these remain purposefully short and fairly minimal because these are add-only modules to the main
cirqdistribution. The main package README will be much fuller.Due to differences in reStructuredText support between GitHub and PyPI, some desirable attractive formatting cannot be achieved without using raw HTML, which PyPI does not support. I decided to focus on PyPI rather than GitHub for these README files; the rationale is that these modules are separate packages on PyPI and thus have their own landing pages there, which makes them more visible than on GitHub where they are buried in subdirectories of the overall Cirq repo. Consequently, these files look slightly better on PyPI than on GitHub.
Here are a couple of examples of what the result looks like on PyPI: