docs(coverage,docs): say which lines of a Go block count as executable - #2194
Merged
Merged
Conversation
Checked against real go test profiles: a block starts at its first statement and ends at its last, so only blank and comment lines between statements are counted. Refs #2186
CoverageTotal: 97.95% ⚪ 0 pp vs Comparing No per-file coverage changes vs 🔇 269 ignored region(s), 0 tolerated region(s)
Patch coverageNo new executable lines added by this diff. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follow-up to #2192 (refs #2186; the issue is already closed by that merge). #2192 merged before this commit was pushed.
The Go coverprofile section said blank and comment lines inside a block count as executable. Checked against real
go test -coverprofileoutput (Go 1.27.1), a block starts at its first statement and ends at its last, so a comment before the first statement or after the last is outside the range. Only blank and comment lines between statements of one block count. This narrows the sentence to that. Docs only.Type of Change
Testing
set/count/atomic, per-package, and a nested module) run through the branch build: all modes agree, sharding andcatof profiles agree, and--strip-prefixmaps a nested module as documented.python3 scripts/check_changelog.py --base origin/main: ok (no code or changelog change; the[Unreleased]entry makes no claim about comment lines).Checklist