Skip to content

update ACE helptext to align with documentation#297

Merged
mmols merged 4 commits into
REL25_01from
chore/PLAT-16/cli-helptext-update
Apr 16, 2025
Merged

update ACE helptext to align with documentation#297
mmols merged 4 commits into
REL25_01from
chore/PLAT-16/cli-helptext-update

Conversation

@mmols
Copy link
Copy Markdown
Member

@mmols mmols commented Apr 14, 2025

No description provided.

@mmols mmols requested review from pct960 and susan-pgedge April 14, 2025 17:58
Comment thread cli/scripts/ace_cli.py
Comment thread cli/scripts/ace_cli.py
Comment thread cli/scripts/ace_cli.py
Comment thread cli/scripts/ace_cli.py
@mmols mmols merged commit 554f34a into REL25_01 Apr 16, 2025
9 checks passed
@mmols mmols deleted the chore/PLAT-16/cli-helptext-update branch April 16, 2025 18:26
Comment thread cli/scripts/ace_cli.py
nodes (str, optional): Comma-delimited subset of nodes on which the
command will be executed. Defaults to "all".
quiet (bool, optional): Whether to suppress output in stdout. Defaults
to False.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default "all" is in quotes, while the default "False" is not...

Comment thread cli/scripts/ace_cli.py
cluster nodes.
nodes (str, optional): Comma-delimited subset of nodes on which the
command will be executed. Defaults to "all".
dbname (str, optional): Name of the database. Defaults to the name of
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, default "all" in quotes, while other defaults are not...

Comment thread cli/scripts/ace_cli.py
"csv". Defaults to "json".
nodes (str, optional): Comma-delimited subset of nodes on which the
command will be executed. Defaults to "all".
batch_size (int, optional): Size of each batch. Defaults to
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More default values in "quotes" - not a show-stopper, but since we build this in and most of it should be a simple fix, do we want to remove ""s for consistency?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants