Make minor edits and updates to Markdown files in docs/ #7009
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 links for Qualtran and Stim, sort the list in alpha order, and remove needless trailing spaces.
Minor edits to add info (e.g., about Qualtran), and make drive-by corrections to punctuation, grammar, and capitalization. This does not include changes to conform to Google Markdown style.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7009 +/- ##
==========================================
- Coverage 97.89% 97.89% -0.01%
==========================================
Files 1085 1085
Lines 95131 95131
==========================================
- Hits 93126 93125 -1
- Misses 2005 2006 +1 ☔ View full report in Codecov by Sentry. |
mhucka
force-pushed
the
mhucka-update-docs
branch
from
a03d3e0 to
2564e8a
Compare
mhucka
requested review from
a team,
verult,
vtomole and
wcourtney
as code owners
A lot of punctuation & minor grammar issues in this one, in addition to adding explanations about some issue labels.
pavoljuhas
approved these changes
Jan 31, 2025
Collaborator
pavoljuhas
left a comment
pavoljuhas
left a comment
There was a problem hiding this comment.
LGTM, with a couple of small tweaks.
Also, excuse my OCD, but can we also fix space issues on the touched lines -
git diff --check main...
| ## Cloning the repository | ||
|
|
||
| The simplest way to get a local copy of cirq that you can edit is by cloning Cirq's github repository: | ||
| The simplest way to get a local copy of Cirq that you can edit is by cloning Cirq's GitHub repository: |
Collaborator
There was a problem hiding this comment.
Let us use web URLs for the suggested git-clone commands.
The current form assumes users have registered their ssh keys on GitHub.
diff --git a/docs/dev/development.md b/docs/dev/development.md
index 3d7f0f92..bea93bf1 100644
--- a/docs/dev/development.md
+++ b/docs/dev/development.md
@@ -11,3 +11,3 @@ The simplest way to get a local copy of Cirq that you can edit is by cloning Cir
```bash
-git clone [email protected]:quantumlib/cirq.git
+git clone https://github.com/quantumlib/Cirq.git
cd Cirq
@@ -53,3 +53,3 @@ where you would like to store your local copy of the code, and `cd` into the new
```bash
- git clone [email protected]:USERNAME/cirq.git
+ git clone https://github.com/USERNAME/Cirq.git
cd Cirq
Also let us capitalize to https://github.com/quantumlib/Cirq.git here -
Line 63 in d3822e9
Contributor
Author
There was a problem hiding this comment.
Good ideas. Will be part of next push.
Contributor
Author
The funny thing is that I wanted to do this too, when editing the files, but left them as-is, to minimize the formatting changes compared to the originals :-). I figured it would be done in a future markdownlint pass. Will be in a new commit momentarily. |
Co-authored-by: Pavol Juhas <[email protected]>
Co-authored-by: Pavol Juhas <[email protected]>
mhucka
changed the title
BichengYing
pushed a commit
to BichengYing/Cirq
that referenced
this pull request
Jun 20, 2025
* Update citation.md Add links for Qualtran and Stim, sort the list in alpha order, and remove needless trailing spaces. * Minor edits and updates to docs/ Minor edits to add info (e.g., about Qualtran), and make drive-by corrections to punctuation, grammar, and capitalization. This does not include changes to conform to Google Markdown style. * Describe some missing issue labels & fix more inconsistencies A lot of punctuation & minor grammar issues in this one, in addition to adding explanations about some issue labels. * Fix NumPy capitalization error from a previous commit * Fix capitalization of SymPy * Update stated version number of grpcio-tools docs/dev/development.md Co-authored-by: Pavol Juhas <[email protected]> * Spell out time zone Co-authored-by: Pavol Juhas <[email protected]> * Merge * Add back a change lost in conflict resolution * Fix a couple of sentences about Docker * Fix a couple of Cirq capitalization issues missed before --------- Co-authored-by: Pavol Juhas <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Minor edits to add info (e.g., about Qualtran), and make drive-by corrections to punctuation, grammar, and capitalization.
This does not include changes to conform to Google Markdown style or more significant editing.