Skip to content

docs: unify doc comments for functions returning bool#7064

Merged
pellared merged 4 commits intoopen-telemetry:mainfrom
pellared:whether
Jul 23, 2025
Merged

docs: unify doc comments for functions returning bool#7064
pellared merged 4 commits intoopen-telemetry:mainfrom
pellared:whether

Conversation

@pellared
Copy link
Copy Markdown
Member

@pellared pellared commented Jul 22, 2025 •
edited
Loading

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
@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 22, 2025 •
edited
Loading

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
pellared commented Jul 22, 2025
View reviewed changes
Comment thread trace/internal/telemetry/id.go
@pellared
Copy link
Copy Markdown
Member Author

pellared commented Jul 22, 2025

CC @XSAM

@pellared pellared mentioned this pull request Jul 22, 2025
Merged
@pellared pellared merged commit 1737ab8 into open-telemetry:main Jul 23, 2025
31 checks passed
@MrAlias MrAlias added this to the v1.38.0 milestone Aug 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dmathieu dmathieu dmathieu approved these changes

@dashpole dashpole dashpole approved these changes

@XSAM XSAM XSAM approved these changes

@MrAlias MrAlias Awaiting requested review from MrAlias MrAlias is a code owner

Assignees

No one assigned

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Milestone

v1.38.0

Development

Successfully merging this pull request may close these issues.

Improve Go doc comments for functions returning bool

5 participants

@pellared @dmathieu @dashpole @XSAM @MrAlias