Skip to content

docs(context): align inline comments in GetPostForm example#4675

Open
leehainuo wants to merge 1 commit into
gin-gonic:masterfrom
leehainuo:docs/align-getpostform-comment
Open

docs(context): align inline comments in GetPostForm example#4675
leehainuo wants to merge 1 commit into
gin-gonic:masterfrom
leehainuo:docs/align-getpostform-comment

Conversation

@leehainuo
Copy link
Copy Markdown

Description

This PR improves the formatting consistency of inline comments in the GetPostForm function documentation example.

Changes

  • Align inline comments in GetPostForm example code (lines 622-623)
  • Improve visual consistency and readability of the documentation

Before:

//	    email=mail@example.com  -->  ("mail@example.com", true) := GetPostForm("email") // set email to "mail@example.com"
//		   email=                  -->  ("", true) := GetPostForm("email") // set email to ""
//	                            -->  ("", false) := GetPostForm("email") // do nothing with email

After:

//	    email=mail@example.com  -->  ("mail@example.com", true) := GetPostForm("email") // set email to "mail@example.com"
//		email=                  -->  ("", true) := GetPostForm("email")                 // set email to ""
//	                            -->  ("", false) := GetPostForm("email")                // do nothing with email

Motivation

  • Maintain consistent comment formatting across documentation
  • Improve code readability for developers reading the documentation

Testing

  • All existing tests pass
  • No functional code changes, documentation only

Pull Request Checklist

Please ensure your pull request meets the following requirements:

  • Open your pull request against the master branch.
  • All tests pass in available continuous integration systems (e.g., GitHub Actions).
  • Tests are added or modified as needed to cover code changes.
  • If the pull request introduces a new feature, the feature is documented in the docs/doc.md.

Thank you for contributing!

Standardize comment alignment in GetPostForm documentation example
to improve readability and maintain consistency with code formatting
conventions.
@codecov
Copy link
Copy Markdown

codecov Bot commented May 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.37%. Comparing base (3dc1cd6) to head (b73528c).
⚠️ Report is 276 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4675      +/-   ##
==========================================
- Coverage   99.21%   98.37%   -0.84%     
==========================================
  Files          42       48       +6     
  Lines        3182     3138      -44     
==========================================
- Hits         3157     3087      -70     
- Misses         17       42      +25     
- Partials        8        9       +1     
Flag Coverage Δ
?
--ldflags="-checklinkname=0" -tags sonic 98.36% <ø> (?)
-tags go_json 98.29% <ø> (?)
-tags nomsgpack 98.35% <ø> (?)
go-1.18 ?
go-1.19 ?
go-1.20 ?
go-1.21 ?
go-1.25 98.37% <ø> (?)
go-1.26 98.37% <ø> (?)
macos-latest 98.37% <ø> (-0.84%) ⬇️
ubuntu-latest 98.37% <ø> (-0.84%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

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.

1 participant