Add info to examples/README.rst & convert to Markdown #6889
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
The `examples/README.rst` file was rather sparse. In order to improve visibility of the many Cirq examples we provide, I added summaries of each example file, as well as some additional general info. In addition, because in past discussions we agreed that readme files that are not associated with setup.py files could be changed to Markdown format, this commit also changes the readme file to Markdown format.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6889 +/- ##
=======================================
Coverage 97.86% 97.87%
=======================================
Files 1084 1084
Lines 94408 94408
=======================================
+ Hits 92393 92398 +5
+ Misses 2015 2010 -5 ☔ View full report in Codecov by Sentry. |
Apparently I got interrupted while writing and didn't realize I didn't finish the last paragraph ...
dstrain115
approved these changes
Jan 14, 2025
BichengYing
pushed a commit
to BichengYing/Cirq
that referenced
this pull request
Jun 20, 2025
The `examples/README.rst` file was rather sparse. In order to improve visibility of the many Cirq examples we provide, I added summaries of each example file, as well as some additional general info. In addition, because in past discussions we agreed that readme files that are not associated with setup.py files could be changed to Markdown format, this commit also changes the readme file to Markdown format.
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.
The
examples/README.rstfile was rather sparse. In order to improve visibility of the many Cirq examples we provide, I added summaries of each example file, as well as some additional general info.In addition, because in past discussions we agreed that readme files that are not associated with setup.py files could be changed to Markdown format, this commit also changes the readme file to Markdown format.