Skip to content

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Aug 14, 2025

Summary

This PR lists flags before examples in generated reference to match outputs of the --help commands 🤖

Preview

The following page and command might demonstrate the purpose of this change:

Reviewers

The generated outputs aren't included in this PR but can be found with these commands:

$ make build && PATH="./bin" slack docgen docs/reference
$ git diff

Requirements

@zimeg zimeg added this to the Next Release milestone Aug 14, 2025
@zimeg zimeg self-assigned this Aug 14, 2025
@zimeg zimeg added the docs M-T: Documentation work only label Aug 14, 2025
@zimeg zimeg requested a review from a team as a code owner August 14, 2025 06:46
@zimeg zimeg added enhancement M-T: A feature request for new functionality semver:patch Use on pull requests to describe the release version increment labels Aug 14, 2025
@codecov
Copy link

codecov bot commented Aug 14, 2025

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 62.94%. Comparing base (2de192d) to head (7180327).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
cmd/docgen/docgen.go 0.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #195      +/-   ##
==========================================
+ Coverage   62.91%   62.94%   +0.03%     
==========================================
  Files         212      212              
  Lines       21782    21782              
==========================================
+ Hits        13704    13711       +7     
+ Misses       7014     7009       -5     
+ Partials     1064     1062       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

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

✅ Much better! Thank you 🙇🏻

Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell left a comment

Choose a reason for hiding this comment

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

🎈

Base automatically changed from zimeg-fix-docgen-template to main August 15, 2025 18:10
@zimeg
Copy link
Member Author

zimeg commented Aug 15, 2025

@mwbrooks @lukegalbraithrussell Thank y'all too. The docs continue to find incredible improvements all around - I hope this can be considered with such changes 🎁

@zimeg zimeg merged commit 859d4f1 into main Aug 15, 2025
6 checks passed
@zimeg zimeg deleted the zimeg-docs-example-order branch August 15, 2025 18:57
@zimeg zimeg removed the enhancement M-T: A feature request for new functionality label Aug 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants