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.

Sign up for GitHub

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

Jump to bottom

Tiny doc bug: incorrect arg shown to dev_tools/modules.py in dev/modules.md #5637

Closed
mhucka opened this issue Jun 29, 2022 · 2 comments
Closed

Tiny doc bug: incorrect arg shown to dev_tools/modules.py in dev/modules.md #5637

mhucka opened this issue Jun 29, 2022 · 2 comments
Labels
good first issue This issue can be resolved by someone who is not familiar with the codebase. A good starting issue. kind/bug-report Something doesn't seem to work.

Comments

@mhucka
Copy link
Contributor

mhucka commented Jun 29, 2022

Description of the issue

In the Cirq modules documentation, at the bottom, the command line to list modules is given as

python dev_tools/modules.py --list

but in fact, attempting to use --list will result in an error, because the argument should actually be list (without the dashes).

How to reproduce the issue

In a shell, with the current directory being the top of the Cirq repo, running python dev_tools/modules.py --list results in the following error:

usage: A utility for modules. [-h] {list,print_version,replace_version} ...
A utility for modules.: error: unrecognized arguments: --list

Cirq version

0.15.0.dev
@mhucka mhucka added the kind/bug-report Something doesn't seem to work. label Jun 29, 2022
@vtomole vtomole added the good first issue This issue can be resolved by someone who is not familiar with the codebase. A good starting issue. label Jun 29, 2022
CirqBot pushed a commit that referenced this issue Jun 29, 2022
@mhucka
Fix for issue #5637 (#5638)
2333536 
The `modules.py` argument parser does not understand the argument
`--list`; it needs to be `list`.
@dstrain115
Copy link
Collaborator

Discussion: this has already been fixed.

@vtomole
Copy link
Collaborator

vtomole commented Jun 29, 2022

Fixed by #5638

@vtomole vtomole closed this as completed Jun 29, 2022
@mhucka mhucka mentioned this issue Jul 8, 2022
Closed
rht pushed a commit to rht/Cirq that referenced this issue May 1, 2023
@mhucka @rht
Fix for issue quantumlib#5637 (quantumlib#5638)
80b53d2 
The `modules.py` argument parser does not understand the argument
`--list`; it needs to be `list`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue This issue can be resolved by someone who is not familiar with the codebase. A good starting issue. kind/bug-report Something doesn't seem to work.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mhucka @vtomole @dstrain115