Skip to content

Commit

Permalink
Rename "verbs" to "commands" in help messages
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiodsf committed May 3, 2024
1 parent 2b4d93b commit a774fc4
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 17 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ To get help, use:

requake -h

The different running modes are specified as "verbs" (positional arguments).
Currently supported verbs are:
Different commands are available:

sample_config write sample config file to current directory and exit
update_config update an existing config file to the latest version
Expand All @@ -105,18 +104,17 @@ Currently supported verbs are:
plot_cumulative cumulative plot for one or more families
map_families plot families on a map
flag_family flag a family of repeating earthquakes as valid or not
valid. Note that all families are valid by default
when first created
valid.
build_templates build waveform templates for one or more event
families
scan_templates scan a continuous waveform stream using one or more
templates

Certain running modes (e.g., `plot_pair`) require further arguments (use, e.g.,
Certain commands (e.g., `plot_pair`) require further arguments (use, e.g.,
`requake plot_pair -h` to get help).

Requake supports command line tab completion for arguments, thanks to
[argcomplete](https://kislyuk.github.io/argcomplete/).
Requake supports command line tab completion for commands and arguments, thanks
to [argcomplete](https://kislyuk.github.io/argcomplete/).
To enable command line tab completion, add the following line to your `.bashrc`
or `.zshrc`:

Expand Down
12 changes: 5 additions & 7 deletions docs/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ To get help, use:
requake -h
The different running modes are specified as "verbs" (positional arguments).
Currently supported verbs are:
Different commands are available:

.. code-block:: text
Expand All @@ -33,19 +32,18 @@ Currently supported verbs are:
plot_cumulative cumulative plot for one or more families
map_families plot families on a map
flag_family flag a family of repeating earthquakes as valid or not
valid. Note that all families are valid by default
when first created
valid.
build_templates build waveform templates for one or more event
families
scan_templates scan a continuous waveform stream using one or more
templates
Certain running modes (e.g., ``plot_pair``\ ) require further arguments
Certain commands (e.g., ``plot_pair``\ ) require further arguments
(use, e.g., ``requake plot_pair -h`` to get help).

Requake supports command line tab completion for arguments, thanks to
`argcomplete <https://kislyuk.github.io/argcomplete/>`_.
Requake supports command line tab completion for commands and arguments, thanks
to `argcomplete <https://kislyuk.github.io/argcomplete/>`_.
To enable command line tab completion, add the following line to your
``.bashrc`` or ``.zshrc``:

Expand Down
5 changes: 2 additions & 3 deletions requake/config/parse_arguments.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def parse_arguments(progname='requake'):
parser = argparse.ArgumentParser(
description=f'{progname}: Repeating earthquakes search and analysis.'
)
subparser = parser.add_subparsers(dest='action')
subparser = parser.add_subparsers(dest='action', title='commands')
parser.add_argument(
'-c',
'--configfile',
Expand Down Expand Up @@ -289,8 +289,7 @@ def parse_arguments(progname='requake'):
# --- flag_family
flagfamily = subparser.add_parser(
'flag_family',
help='flag a family of repeating earthquakes as valid or not valid. '
'Note that all families are valid by default when first created'
help='flag a family of repeating earthquakes as valid or not valid'
)
flagfamily.add_argument('family_number')
flagfamily.add_argument(
Expand Down

0 comments on commit a774fc4

Please sign in to comment.