docs: resolve results-field and receive-polarity contradictions
commit
76bc3c5docs: resolve results-field and receive-polarity contradictions
abstractions.adoc’s Effect struct sample carried a results: RefName
field that contradicted its own surrounding narrative and the spec
tree, which already correctly derive the results refname from the
effect’s name. receive.shared-path inverted the "no shared push path,
shared receive" polarity abstractions.adoc states elsewhere.
fixes: abstractions.adoc Effect struct sample (results field removed) fixes: receive.shared-path polarity to match abstractions.adoc §push-path
Reviews
No reviews of this commit yet — record a verdict below.
Start a review
docs/abstractions.adoc
@@ -126,10 +126,11 @@
trigger: CommitQuery, // a commit set as a function of ref state
toolchains: Vec<ToolchainRef>, // e.g. ["rust-1.88"]
run: Command,
- results: RefName, // e.g. "refs/meta/results/<name>/*"
}
----
+Results location is derived by convention, never declared by the effect: an effect cannot choose where its verdicts land.
+
*Trigger semantics:* the trigger denotes a set of commits; the effect fires once per commit that *enters* the set.
The query algebra is deliberately tiny:
docs/spec/receive.adoc
@@ -27,8 +27,9 @@
object database.
Smart-HTTP MUST unpack the incoming wire pack into the `ObjectStore` before
calling `receive`.
-Local and hosted MUST NOT diverge into separate push paths; they share
-`receive`, which is the correctness anchor for writes.
+Local and hosted MUST NOT share a push path; they MUST share `receive`,
+with only the trait implementations swapped, which is the correctness
+anchor for writes.
--
[role="requirement", id="receive.refstore-seam"]