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

Change rendering of visible aliases to be more prominent #5454

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tertsdiepraam
Copy link
Contributor

@tertsdiepraam tertsdiepraam commented Apr 14, 2024

Hi! We got an issue on the coreutils (uutils/coreutils#6223) about visible aliases not being prominent enough. This is an attempt at fixing that. I'm opening a PR directly instead of opening an issue because I wanted to see what it would look like, but I can move the discussion to an issue if you want. CI will also fail on this, because I haven't adapted the tests yet.

In short, the help output with this change looks like this:

Options:
  -m, -a, --manifest-path, --blabla <PATH>  
  -h, --help                  Print help
  -V, --version               Print version

Instead of the [short aliases: ...] and [aliases: ...]. However, I would be happy to try other formats if you prefer. With this format the help output gets misaligned. I haven't looked into that yet and would first like to discuss whether you would even accept this change.

Another issue is that the argument might need to be duplicated. In the example above, it looks like only --blabla takes an argument and --manifest-path does not.

If you don't want this as default behaviour, I could also make it optional.

Let me know what you think :)

@epage
Copy link
Member

epage commented Apr 15, 2024

Please open an issue for discussing this. I've adopted a pretty strict "problem/solutions are discussed in issues, implementation is discussed in PRs" stance after seeing PRs go on for too long, a conversation split across multiple PRs, and as a personal boundary as there is social pressure to move PRs along towards being merged.

@tertsdiepraam
Copy link
Contributor Author

Apologies, will do that soon!

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.

None yet

2 participants