Skip to content

skip nested help subcommands #16

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

skip nested help subcommands #16

wants to merge 1 commit into from

Conversation

@starius
Copy link
Contributor

@starius starius commented Oct 6, 2025

When every command has a nested "help" subcommand it is harder to read the documentation.

@starius starius requested a review from a team as a code owner October 6, 2025 23:39
starius added a commit to starius/loop that referenced this pull request Oct 7, 2025
@starius
cmd/loop: add commands "loop man", "loop markdown"
d204536 
Produce the documentations in man .1 and markdown formats.

The template for markdown was patched to removed column "Environment variables"
Upstream PR: urfave/cli-docs#15

Also the input has to be pre-processed to remove nested "help" subcommands from
each subcommand to improve readability.
Upstream PR: urfave/cli-docs#16
starius added a commit to starius/loop that referenced this pull request Oct 7, 2025
@starius
cmd/loop: add commands "loop man", "loop markdown"
44638ad 
Produce the documentations in man .1 and markdown formats.

The template for markdown was patched to removed column "Environment variables"
Upstream PR: urfave/cli-docs#15

Also the input has to be pre-processed to remove nested "help" subcommands from
each subcommand to improve readability.
Upstream PR: urfave/cli-docs#16
starius added a commit to starius/loop that referenced this pull request Oct 7, 2025
@starius
cmd/loop: add commands "loop man", "loop markdown"
941233e 
Produce the documentations in man .1 and markdown formats.

The template for markdown was patched to removed column "Environment variables"
Upstream PR: urfave/cli-docs#15

Also the input has to be pre-processed to remove nested "help" subcommands from
each subcommand to improve readability.
Upstream PR: urfave/cli-docs#16
starius added a commit to starius/loop that referenced this pull request Oct 7, 2025
@starius
cmd/loop: add commands "loop man", "loop markdown"
30292fe 
Produce the documentations in man .1 and markdown formats.

The template for markdown was patched to removed column "Environment variables"
Upstream PR: urfave/cli-docs#15

Also the input has to be pre-processed to remove nested "help" subcommands from
each subcommand to improve readability.
Upstream PR: urfave/cli-docs#16
starius added a commit to starius/loop that referenced this pull request Oct 7, 2025
@starius
cmd/loop: add commands "loop man", "loop markdown"
1641cac 
Produce the documentations in man .1 and markdown formats.

The template for markdown was patched to removed column "Environment variables"
Upstream PR: urfave/cli-docs#15

Also the input has to be pre-processed to remove nested "help" subcommands from
each subcommand to improve readability.
Upstream PR: urfave/cli-docs#16
starius added a commit to starius/loop that referenced this pull request Oct 7, 2025
@starius
cmd/loop: add commands "loop man", "loop markdown"
7054ea7 
Produce the documentations in man .1 and markdown formats.

The template for markdown was patched to removed column "Environment variables"
Upstream PR: urfave/cli-docs#15

Also the input has to be pre-processed to remove nested "help" subcommands from
each subcommand to improve readability.
Upstream PR: urfave/cli-docs#16
starius added a commit to starius/loop that referenced this pull request Oct 7, 2025
@starius
cmd/loop: add commands "loop man", "loop markdown"
15f9423 
Produce the documentations in man .1 and markdown formats.

The template for markdown was patched to removed column "Environment variables"
Upstream PR: urfave/cli-docs#15

Also the input has to be pre-processed to remove nested "help" subcommands from
each subcommand to improve readability.
Upstream PR: urfave/cli-docs#16
@dearchap
Copy link
Contributor

dearchap commented Oct 20, 2025

@starius I'm wondering if someone might want the help in nested subcommands ?

@starius
skip nested help subcommands
0661a34 
When every command has a nested "help" subcommand it is harder to read the
documentation.
@starius
Copy link
Contributor Author

starius commented Oct 20, 2025

Rebased to resolve conflicts.

@starius
Copy link
Contributor Author

starius commented Oct 20, 2025

@dearchap I don't think nested help command is useful in the documentation. Even if someone reading the docs doesn't know about it, there is a --help flag in each sub-command, so they could use it, getting the same result.

I use cli-docs to generate man and markdown files for Loop documentation and paragraphs for help subcommands are really annoying. Compare how the manual looks without the nested help subcommands:
https://github.com/lightninglabs/loop/blob/master/docs/loop.md
and compare with how it looks if help subcommands are present:
https://gist.github.com/starius/0f67e6dfb2c74b8c0866a65c5d015b75

dearchap
dearchap reviewed Nov 3, 2025
View reviewed changes
docs.go
if command.Hidden {
continue
}
if level > 0 && command.Name == "help" {
Copy link
Contributor

@dearchap dearchap Nov 3, 2025

Choose a reason for hiding this comment

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

I'm wondering if we need to compare this with helpCommand.Name instead ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dearchap dearchap dearchap left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@starius @dearchap