Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and refresh cirq-* module README files #6900

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mhucka
Copy link
Contributor

@mhucka mhucka commented Dec 31, 2024

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. 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:

image image

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.
@CirqBot CirqBot added the size: L 250< lines changed <1000 label Dec 31, 2024
rstcheck complains about it.
Copy link

codecov bot commented Dec 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@5ffb3ad). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6900   +/-   ##
=======================================
  Coverage        ?   97.86%           
=======================================
  Files           ?     1084           
  Lines           ?    94299           
  Branches        ?        0           
=======================================
  Hits            ?    92281           
  Misses          ?     2018           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs size: L 250< lines changed <1000
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants