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

Command summary displays as topic summary when nested below topic without summary. #1029

Closed
rbayliss opened this issue Mar 21, 2024 · 1 comment

Comments

@rbayliss
Copy link

Describe the bug
Given a command in a subdirectory of the main commands directory, when I add either a summary property, or a description property, that text then appears as the topic summary at the top level.

To Reproduce
Steps to reproduce the behavior:

  1. Setup @oclif/core add add @oclif/plugin-help.
  2. Create a command class on bar.ts in a subdirectory foo and give it a static summary property.
  3. Run your binary without specifying any particular command.
  4. Observe the the foo topic prints with the summary you added to the bar command.

Expected behavior
The foo topic has no summary.

Screenshots
If applicable, add screenshots to help explain your problem.

Environment (please complete the following information):

  • OS & version: OSX Sonoma
  • Shell/terminal & version: zsh 5.9
@mdonnalley
Copy link
Contributor

You can set topic descriptions in the package.json. See https://oclif.io/docs/topics

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

No branches or pull requests

2 participants