Strip trailing blank line from generated CLI docs#14
Merged
Conversation
Cobra's markdown generator emits files ending with a blank line, which trips 'git diff --check' whenever a doc gets modified near EOF. Add a post-processing pass to generate-docs that collapses trailing newlines to a single \n, and regenerate every doc to match.
nathanjcochran
approved these changes
May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cobra's
doc.GenMarkdownTreeemits files that end with a blank line (...text\n\n).git diff --checkflags that as a whitespace error whenever a doc gets added or its tail modified — e.g. the doc EOF issues called out in the review of #13.Fix: post-process generated markdown in
cmd/generate-docsto collapse trailing newlines down to a single\n, and regenerate every CLI doc to match. Future regenerations stay clean automatically.The 52 doc-file changes are mechanical (one trailing newline removed each); the only behavior change is in
cmd/generate-docs/main.go.