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

docsgen-cli skips remaining subcommands if one has an empty line in its usage #12705

Open
masih opened this issue Nov 19, 2024 · 1 comment
Open
Labels
kind/bug Kind: Bug

Comments

@masih
Copy link
Member

masih commented Nov 19, 2024

The docsgen-cli was originally written in Python as a way of automatically generate CLI docs by recursively running help on all sub commands. This was then ported over to Golang for faster execution without changing the logic.

The logic is imperfect: it makes imlicit assumptions about the pattern of usage printed. One of which is that If there exists an empty new line we have reached the end of sub commands for a given command. This implicit assumption breaks when usage of a subcommand contains newlines.

@masih
Copy link
Member Author

masih commented Dec 4, 2024

This issue will become irrelevant once #12706 gets done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Kind: Bug
Projects
Status: 📌 Triage
Development

No branches or pull requests

1 participant