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

Improve man and shell completion for tools #15082

Merged
merged 2 commits into from
Oct 15, 2024

Conversation

Blacksmoke16
Copy link
Member

@Blacksmoke16 Blacksmoke16 commented Oct 13, 2024

Partial follow up to #15059 to update man docs with new format. Also noticed I'm unable to tab complete unreachable on bash, so fixed that and ensured all tools and options are present in each shell completion file.

As a side node, it's a real PITA to update these. Would be 💯 if there was a way to generate these via some configuration or something 🤷.

@Blacksmoke16 Blacksmoke16 added kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:infrastructure topic:tools and removed topic:infrastructure labels Oct 13, 2024
Copy link
Member

@straight-shoota straight-shoota left a comment

Choose a reason for hiding this comment

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

question: Is there any particular reason for breaking the alphabetical order of subcommands in the listings?

@Blacksmoke16
Copy link
Member Author

It seems I matched the order that crystal tool --help is in. Maybe should update that to be alphabetical order too?

@straight-shoota straight-shoota added this to the 1.15.0 milestone Oct 14, 2024
@straight-shoota straight-shoota merged commit 5fd469c into crystal-lang:master Oct 15, 2024
66 checks passed
@Blacksmoke16 Blacksmoke16 deleted the tool-docs branch October 15, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants