Skip to content

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

Closed
@mhucka

Description

@mhucka

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueThis issue can be resolved by someone who is not familiar with the codebase. A good starting issue.kind/bug-reportSomething doesn't seem to work.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions