Skip to content

docs: unify doc comments for functions returning bool #7064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 23, 2025

Conversation

pellared
Copy link
Member

@pellared pellared commented Jul 22, 2025

Fixes #7063

If also fixes Go Doc comment for SpanID.IsEmpty.

The pattern is based on the way the Go standard library documents functions returning a boolean.
Examples:

@pellared pellared added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jul 22, 2025
Copy link

codecov bot commented Jul 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.9%. Comparing base (50868ef) to head (2ff9e4a).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #7064   +/-   ##
=====================================
  Coverage   82.9%   82.9%           
=====================================
  Files        262     262           
  Lines      24460   24460           
=====================================
  Hits       20281   20281           
  Misses      3801    3801           
  Partials     378     378           
Files with missing lines Coverage Δ
attribute/encoder.go 85.0% <ø> (ø)
attribute/iterator.go 91.7% <ø> (ø)
attribute/key.go 100.0% <ø> (ø)
attribute/kv.go 91.6% <ø> (ø)
attribute/set.go 81.7% <ø> (ø)
bridge/opencensus/internal/span.go 100.0% <ø> (ø)
log/keyvalue.go 94.7% <ø> (ø)
log/logger.go 100.0% <ø> (ø)
sdk/internal/x/x.go 100.0% <ø> (ø)
sdk/metric/instrument.go 97.8% <ø> (ø)
... and 10 more

... and 3 files with indirect coverage changes

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

@pellared
Copy link
Member Author

CC @XSAM

@pellared pellared merged commit 1737ab8 into open-telemetry:main Jul 23, 2025
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Go doc comments for functions returning bool
4 participants