Skip to content

Commit

Permalink
CLI: Unify help messages for verdi computer print commands
Browse files Browse the repository at this point in the history
Use key word "show" for `verdi computer` commands that only print an output.
  • Loading branch information
agoscinski committed May 28, 2024
1 parent 2d2afca commit d362291
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/reference/command_line.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ Below is a list with all available subcommands.
repair Automatically repair all stuck processes.
report Show the log report for the process(es).
show Show details for the given process(es).
status Print the status of the given process(es).
status Show the status of the given process(es).
watch Watch the state transitions of the given process(es).
Expand Down
4 changes: 2 additions & 2 deletions src/aiida/cmdline/commands/cmd_process.py
Original file line number Diff line number Diff line change
Expand Up @@ -273,15 +273,15 @@ def process_report(processes, most_recent_node, levelname, indent_size, max_dept
echo.echo(f'Nothing to show for node type {process.__class__}')


@verdi_process.command('status', short_help='Print the status of the given process(es).')
@verdi_process.command('status', short_help='Show the status of the given process(es).')
@options.MOST_RECENT_NODE()
@click.option('-c', '--call-link-label', 'call_link_label', is_flag=True, help='Include the call link label if set.')
@click.option(
'-m', '--max-depth', 'max_depth', type=int, default=None, help='Limit the number of levels to be printed.'
)
@arguments.PROCESSES()
def process_status(call_link_label, most_recent_node, max_depth, processes):
"""Print the status of one or multiple processes given the primary key(s) (PK)."""
"""Show the status of one or multiple processes given the primary key(s) (PK)."""
from aiida.cmdline.utils.ascii_vis import format_call_graph

if not (processes) and not (most_recent_node):
Expand Down

0 comments on commit d362291

Please sign in to comment.