Skip to content

docs: fix progress download comment grammar#1640

Open
Rohan5commit wants to merge 1 commit intocharmbracelet:mainfrom
Rohan5commit:docs/fix-progress-comment-20260320
Open

docs: fix progress download comment grammar#1640
Rohan5commit wants to merge 1 commit intocharmbracelet:mainfrom
Rohan5commit:docs/fix-progress-comment-20260320

Conversation

@Rohan5commit
Copy link
Copy Markdown
Contributor

Summary

  • fix a grammar issue in the examples/progress-download comment
  • keep the change limited to one file with no behavior impact

Related issue

  • N/A

Guideline alignment

Validation/testing

  • Not run; comment-only change

Copilot AI review requested due to automatic review settings March 20, 2026 04:17
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.09%. Comparing base (88dda9f) to head (1185408).
⚠️ Report is 2 commits behind head on main.

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.
📢 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
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines +69 to +70
// Don't add TUI if the header doesn't include content size, since it's
// impossible to show progress without a total.
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
// 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.

Copilot uses AI. Check for mistakes.
@MukundaKatta
Copy link
Copy Markdown

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 ):

⭾⭾// Don't add TUI if the header doesn't include content size, since it's
⭾⭾// impossible to show progress without a total.
⭾if resp.ContentLength <= 0 {

Dropping one tab from each comment line should line it up with the `if` below.

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.

4 participants