Skip to content

Exclude hidden argument content from generate-manual output#667

Merged
natecook1000 merged 1 commit into
apple:mainfrom
heckj:issue665
Sep 30, 2024
Merged

Exclude hidden argument content from generate-manual output#667
natecook1000 merged 1 commit into
apple:mainfrom
heckj:issue665

Conversation

@heckj

@heckj heckj commented Sep 19, 2024

Copy link
Copy Markdown
Contributor

Resolves issue #665, which suppresses the output for arguments that are marked as hidden - from synopsis, single page output, and multi-page output for generate-manual.

Checklist

  • I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

- adds check in single and multipage to leverage hidden description in
  help dump to determine if the argument should be displayed
- adds check in argument synopsis to only display synopsis if not hidden
- updates existing tests that _had_ hidden output displayed in the
  generate-manual output
@heckj heckj changed the title Issue665 Exclude hidden argument content from generate-manual output Sep 20, 2024

@rauhul rauhul left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think this looks good to merge

@rauhul

rauhul commented Sep 26, 2024

Copy link
Copy Markdown
Collaborator

@swift-ci test

@natecook1000

Copy link
Copy Markdown
Member

Thanks for this fix, @heckj! 🎉

@natecook1000 natecook1000 merged commit 7f9f965 into apple:main Sep 30, 2024
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.

3 participants