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

chore: minor qol fixes #122

Merged
merged 2 commits into from
Dec 4, 2024
Merged

chore: minor qol fixes #122

merged 2 commits into from
Dec 4, 2024

Conversation

kian99
Copy link
Contributor

@kian99 kian99 commented Dec 4, 2024

Description

This PR recreates #120.

This PR makes some minor QoL improvements:

  1. (First commit) Links to a different section of text in markdown should use - instead of _ for links with spaces. If a command has subcommands, the generated markdown currently resemble #command_subcommand and wouldn't properly navigate, instead #command-subcommand works.

  2. (First commit) There is no line break between the end of the index file and the markdown separator ---- which causes issues when converting the markdown to other formats.

  3. (Second commit) Always print command usage. The usage is only printed if a command has arguments, commonly empty for list style commands. But these commands should also have a usage section in the docs.

Links to a different section of text in markdown should use - instead of _ for links with spaces.
Also adds a newline before the line break marker in the index.
The usage was only printed if the command has arguments, common for `list` style commands. But these commands should also have a usage section in the docs.
@kian99 kian99 force-pushed the minor-qol-tweaks-v3 branch from 37f1202 to eb95f3f Compare December 4, 2024 12:37
@kian99 kian99 changed the title chore: allow escaping to be skipped and minor qol fixes chore: minor qol fixes Dec 4, 2024
@kian99
Copy link
Contributor Author

kian99 commented Dec 4, 2024

@tmihoc This PR makes a change to when usage is printed. I noticed list-clouds doesn't have a Usage section but add-cloud. I think they should both have a usage section. Any thoughts?

Copy link
Member

@tmihoc tmihoc left a comment

Choose a reason for hiding this comment

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

Can't comment on the code, but the output looks good to me, thanks!

(I might have follow-up comments once I've looked at an actual real-life example.)

testdata/list-clouds.md Show resolved Hide resolved
testdata/list-clouds.md Show resolved Hide resolved
@kian99
Copy link
Contributor Author

kian99 commented Dec 4, 2024

/merge

@jujubot jujubot merged commit 0458506 into juju:v3 Dec 4, 2024
1 of 2 checks passed
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.

4 participants