-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Minor edits and updates to Markdown files in docs/ #7009
Conversation
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. |
a03d3e0
to
2564e8a
Compare
A lot of punctuation & minor grammar issues in this one, in addition to adding explanations about some issue labels.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 git@github.com: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 git@github.com: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
git remote add upstream https://github.com/quantumlib/cirq.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good ideas. Will be part of next push.
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 <pavol.juhas@gmail.com>
Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com>
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.