Skip to content

cargo ci self-docs uses doc comments as well as explicit helptext#4860

Merged
bfops merged 2 commits intomasterfrom
bfops/ci-helptext
Apr 22, 2026
Merged

cargo ci self-docs uses doc comments as well as explicit helptext#4860
bfops merged 2 commits intomasterfrom
bfops/ci-helptext

Conversation

@bfops
Copy link
Copy Markdown
Collaborator

@bfops bfops commented Apr 21, 2026

Description of Changes

Several args for cargo ci had empty helptext, because we were only printing the explicitly-annotated helptext. This PR updates it so that inline helptext also shows in the README.

API and ABI breaking changes

None. CI only.

Expected complexity level and risk

1

Testing

  • Updated README has more helptext

@bfops bfops marked this pull request as ready for review April 22, 2026 19:00
@bfops bfops changed the title CI self-docs uses doc comments as well as explicit helptext cargo ci self-docs uses doc comments as well as explicit helptext Apr 22, 2026
Copy link
Copy Markdown
Collaborator

@jdetter jdetter left a comment

Choose a reason for hiding this comment

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

LGTM, not tested by me

@bfops bfops added this pull request to the merge queue Apr 22, 2026
Merged via the queue into master with commit e2a74b5 Apr 22, 2026
36 of 37 checks passed
@bfops bfops deleted the bfops/ci-helptext branch April 28, 2026 16:02
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.

2 participants