docs: fix progress download comment grammar#1640
docs: fix progress download comment grammar#1640Rohan5commit wants to merge 1 commit intocharmbracelet:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1640 +/- ##
=======================================
Coverage 56.09% 56.09%
=======================================
Files 25 25
Lines 1287 1287
=======================================
Hits 722 722
Misses 481 481
Partials 84 84 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Updates a comment in the examples/progress-download example to improve grammar/clarity without changing runtime behavior.
Changes:
- Rephrases the “no Content-Length header” comment for clearer English.
- Splits the comment across two lines.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // Don't add TUI if the header doesn't include content size, since it's | ||
| // impossible to show progress without a total. |
There was a problem hiding this comment.
These comment lines are indented one level deeper than the surrounding code in main(). This will likely be flagged by the repo’s formatting checks (gofumpt/goimports enabled in .golangci.yml); please align the indentation (or run the configured formatter) so the comment sits at the same indent level as the following if statement.
| // Don't add TUI if the header doesn't include content size, since it's | |
| // impossible to show progress without a total. | |
| // Don't add TUI if the header doesn't include content size, since it's | |
| // impossible to show progress without a total. |
|
Grammar tweak reads better — one small thing: the new lines are indented with two tabs where the original had one, but the surrounding `if` block is indented with a single tab, so the comment is now indented one level deeper than the code it documents. `gofmt` or `go vet` should flag it, and reviewers tend to squint at this. Current diff (tabs shown as Dropping one tab from each comment line should line it up with the `if` below. |
Summary
examples/progress-downloadcommentRelated issue
Guideline alignment
Validation/testing