search

quantumlib / Cirq

A Python framework for creating, editing, and invoking Noisy Intermediate Scale Quantum (NISQ) circuits.
Apache License 2.0
4.28k stars 1.02k forks source link

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

Closed mhucka closed 3 months ago

mhucka commented 3 months ago

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