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

dev docs suggest using "git remote -va" but -a is not a valid flag #6686

Closed
mhucka opened this issue Jul 31, 2024 · 0 comments · Fixed by #6688
Closed

dev docs suggest using "git remote -va" but -a is not a valid flag #6686

mhucka opened this issue Jul 31, 2024 · 0 comments · Fixed by #6688
Labels
kind/bug-report Something doesn't seem to work. triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on

Comments

@mhucka
Copy link
Contributor

mhucka commented Jul 31, 2024

Description of the issue

There is a very minor and non-urgent documentation bug in the dev install instructions. At one point, the steps suggest running git remote -va, but this leads to an error that a is an unknown switch for git remote.

How to reproduce the issue

The problem is visible in the online docs at quantumai.google, as well as in the dev installation instructions in GitHub. In the online docs at quantumai.google, the comment under step 4 in the instructions at https://quantumai.google/cirq/dev/development#forking_the_repository is the following:

However, actually doing git remote -va (at least in versions 2.39 and higher) produces an error:

error: unknown switch `a'

The source text appears to be line 34 in docs/dev/development.md.

Cirq version

> python -c 'import cirq; print(cirq.__version__)'
1.4.1
@mhucka mhucka added the kind/bug-report Something doesn't seem to work. label Jul 31, 2024
@NoureldinYosri NoureldinYosri added the triage/discuss Needs decision / discussion, bring these up during Cirq Cynque label Jul 31, 2024
@senecameeks senecameeks added triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on and removed triage/discuss Needs decision / discussion, bring these up during Cirq Cynque labels Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug-report Something doesn't seem to work. triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants