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

Minor edits and updates to Markdown files in docs/ #7009

Merged
merged 14 commits into from
Jan 31, 2025

Conversation

mhucka
Copy link
Contributor

@mhucka mhucka commented Jan 31, 2025

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.

Add links for Qualtran and Stim, sort the list in alpha order, and
remove needless trailing spaces.
@CirqBot CirqBot added the size: L 250< lines changed <1000 label Jan 31, 2025
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.
Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.89%. Comparing base (bb10251) to head (54ad17f).
Report is 4 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@mhucka mhucka force-pushed the mhucka-update-docs branch from a03d3e0 to 2564e8a Compare January 31, 2025 01:07
@mhucka mhucka marked this pull request as ready for review January 31, 2025 01:11
@mhucka mhucka requested review from wcourtney, vtomole, verult and a team as code owners January 31, 2025 01:11
@mhucka mhucka enabled auto-merge January 31, 2025 01:12
@mhucka mhucka requested a review from pavoljuhas January 31, 2025 01:12
A lot of punctuation & minor grammar issues in this one, in addition
to adding explanations about some issue labels.
Copy link
Collaborator

@pavoljuhas pavoljuhas left a 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...

docs/dev/development.md Outdated Show resolved Hide resolved
docs/dev/triage.md Outdated Show resolved Hide resolved


## 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:
Copy link
Collaborator

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 -

git remote add upstream https://github.com/quantumlib/cirq.git

Copy link
Contributor Author

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.

@mhucka mhucka added this pull request to the merge queue Jan 31, 2025
@pavoljuhas pavoljuhas removed this pull request from the merge queue due to a manual request Jan 31, 2025
@mhucka
Copy link
Contributor Author

mhucka commented Jan 31, 2025

Also, excuse my OCD, but can we also fix space issues on the touched lines -

git diff --check main...

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.

@mhucka mhucka enabled auto-merge January 31, 2025 22:30
@mhucka mhucka added this pull request to the merge queue Jan 31, 2025
Merged via the queue into quantumlib:main with commit aba898c Jan 31, 2025
38 checks passed
@mhucka mhucka deleted the mhucka-update-docs branch January 31, 2025 22:49
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.

3 participants