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

maint: Clarify env subcommand documentation in help menu #3502

Merged
merged 2 commits into from
Oct 15, 2024
Merged

maint: Clarify env subcommand documentation in help menu #3502

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
372f90c
maint: Clarify `env` subcommand documentation in help menu
jjerphan Oct 3, 2024
e0c3eb0
Update comment
jjerphan Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/user_guide/micromamba.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Quickstarts
config Configuration of micromamba
info Information about micromamba
constructor Commands to support using micromamba in constructor
env List environments
env Access information about environments
activate Activate an environment
run Run an executable in an environment
ps Show, inspect or kill running processes
Expand Down
2 changes: 1 addition & 1 deletion libmamba/data/mamba.fish
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ __fish_mamba_complete_subcmds '__fish_mamba_has_command' '
config Configuration of micromamba
info Information about micromamba
constructor Commands to support using micromamba in constructor
env List environments
env Access information about environments
Copy link
Member

Choose a reason for hiding this comment

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

The help message should be consistent (the same) everywhere:

Suggested change
env Access information about environments
env See `mamba/micromamba env --help`.

activate Activate an environment
run Run an executable in an environment
ps Show, inspect or kill running processes
Expand Down
2 changes: 1 addition & 1 deletion micromamba/src/umamba.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ set_umamba_command(CLI::App* com, mamba::Configuration& config)
);
set_constructor_command(constructor_subcom, config);

CLI::App* env_subcom = com->add_subcommand("env", "List environments");
CLI::App* env_subcom = com->add_subcommand("env", "Access information about environments");
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
CLI::App* env_subcom = com->add_subcommand("env", "Access information about environments");
CLI::App* env_subcom = com->add_subcommand("env", "See `mamba/micromamba env --help`.");

set_env_command(env_subcom, config);

CLI::App* activate_subcom = com->add_subcommand("activate", "Activate an environment");
Expand Down
Loading