Skip to content

Commit 383a70b

Browse files
committed
docs(stovepipe): say which scopes use degree endpoints and which use the interval
The previous wording claimed intermediate values describe partial breakage without saying for what, which read as though a whole-repository build could be partly green. Addresses review feedback on #552.
1 parent be336e7 commit 383a70b

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

‎stovepipe/entity/validation_fact.go‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515
package entity
1616

1717
// Degree bounds. A degree answers "how broken was this scope?" on a closed
18-
// interval, so the two endpoints are named and the values between them are
19-
// meaningful rather than arbitrary.
18+
// interval, so both endpoints are named rather than spelled as bare literals.
2019
const (
2120
// DegreeGreen is a fully healthy scope: nothing broken.
2221
DegreeGreen = 0.0
@@ -42,8 +41,10 @@ type ValidationFact struct {
4241
// repository; named projects narrow the fact to part of it.
4342
Project string `json:"project"`
4443
// Degree is how broken the scope was, on the closed interval
45-
// [DegreeGreen, DegreeBroken]. Intermediate values describe partial
46-
// breakage.
44+
// [DegreeGreen, DegreeBroken]. A whole-repository scope only ever takes an
45+
// endpoint: the build either passed or it did not. Intermediate values
46+
// belong to project-level scopes, whose analysis defines how a partial
47+
// degree is derived.
4748
Degree float64 `json:"degree"`
4849
// RequestID is the request that established the fact.
4950
RequestID string `json:"request_id"`

0 commit comments

Comments
 (0)