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.

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

The help screen for a bad SCIE_BOOT could be better. #143

Closed
jsirois opened this issue Sep 18, 2023 · 0 comments · Fixed by #145
Closed

The help screen for a bad SCIE_BOOT could be better. #143

jsirois opened this issue Sep 18, 2023 · 0 comments · Fixed by #145
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@jsirois
Copy link
Collaborator

jsirois commented Sep 18, 2023

Here I use the scie-pants pants scie to demonstrate:

$ SCIE_BOOT=bad pants
Error: Isolates your Pants from the elements.

Please select from the following boot commands:

scie-pants
bootstrap-tools
pants
pants-debug
update

You can select a boot command by passing it as the 1st argument or else by setting the SCIE_BOOT environment variable.

Now, in this case, the error should be pretty obvious since I typed SCIE_BOOT=bad pants which is right there in the console along with the error message. Things are more mysterious though if I previously exported SCIE_BOOT=bad into the environment, in which case you just see:

$ pants
Error: Isolates your Pants from the elements.

Please select from the following boot commands:

scie-pants
bootstrap-tools
pants
pants-debug
update

You can select a boot command by passing it as the 1st argument or else by setting the SCIE_BOOT environment variable.

Better would probably be something like:

$ pants
Error: SCIE_BOOT="bad" was found in the environment but "bad" does not correspond to any pants subcommands.

Please select from the following boot commands:
<default> (when SCIE_BOOT is not in the environment): Isolates your Pants from the elements.
scie-pants
bootstrap-tools
pants
pants-debug
update

You can select a boot command by passing it as the 1st argument or else by setting the SCIE_BOOT environment variable.
@jsirois jsirois added bug Something isn't working documentation Improvements or additions to documentation labels Sep 18, 2023
@jsirois jsirois self-assigned this Sep 19, 2023
@jsirois jsirois added the in progress Indicates the assignee is actively working on the item. label Sep 19, 2023
jsirois added a commit to jsirois/jump that referenced this issue Sep 19, 2023
This fixes the error messages displayed when a boot command could not be
found by both differentiating the cases where this can occur with their
own specialized messages and improving the guidance in general.

As part of these messaging fixes, support for hiding commands is added
by omitting descriptions for those named commands you wish to hide from
the boot failure help screen.

Fixes a-scie#143
Fixes a-scie#144
jsirois added a commit to jsirois/jump that referenced this issue Sep 19, 2023
This fixes the error messages displayed when a boot command could not be
found by both differentiating the cases where this can occur with their
own specialized messages and improving the guidance in general.

As part of these messaging fixes, support for hiding commands is added
by omitting descriptions for those named commands you wish to hide from
the boot failure help screen.

Fixes a-scie#143
Fixes a-scie#144
jsirois added a commit to jsirois/jump that referenced this issue Sep 19, 2023
This fixes the error messages displayed when a boot command could not be
found by both differentiating the cases where this can occur with their
own specialized messages and improving the guidance in general.

As part of these messaging fixes, support for hiding commands is added
by omitting descriptions for those named commands you wish to hide from
the boot failure help screen.

Fixes a-scie#143
Fixes a-scie#144
jsirois added a commit that referenced this issue Sep 19, 2023
This fixes the error messages displayed when a boot command could not be
found by both differentiating the cases where this can occur with their
own specialized messages and improving the guidance in general.

As part of these messaging fixes, support for hiding commands is added
by omitting descriptions for those named commands you wish to hide from
the boot failure help screen.

Fixes #143
Fixes #144
@jsirois jsirois removed the in progress Indicates the assignee is actively working on the item. label Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant