Skip to content

chore(agents): own docs are not a test oracle - #2155

Merged
Benoît Cortier (CBenoit) merged 1 commit into
masterfrom
chore/oracle-own-docs-not-reference
Oct 27, 2026
Merged

Benoît Cortier (CBenoit) merged 1 commit into
masterfrom
chore/oracle-own-docs-not-reference

Conversation

@CBenoit

@CBenoit Benoît Cortier (CBenoit) commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Documentation written with the code, or generated from it, describes what the code does rather than deciding what it must do, so a test whose expected value rests on it detects change, not bugs. The test-oracle-reviewer skill now lists such documentation, including a trait's rustdoc and an OpenAPI file generated from annotations, among self-derived sources, and limits the reference kind to another implementation, a capture, or a reference model.

A property such as encode writing exactly size() bytes is an independent source only when an intent, contract, or spec states it. A test citing the code's own documentation is re-cited to the sentence that decides its value, kept as mutant when it alone catches a fault, or deleted, and test-pruner records it as self-derived so the pass flags it for removal.

Changelog: ignore

🤖 Generated with Claude Code

Documentation written with the code, or generated from it, describes
what the code does rather than deciding what it must do, so a test
whose expected value rests on it detects change, not bugs. The
test-oracle-reviewer skill now lists such documentation, including a
trait's rustdoc and an OpenAPI file generated from annotations, among
self-derived sources, and limits the `reference` kind to another
implementation, a capture, or a reference model.

A property such as `encode` writing exactly `size()` bytes is an
independent source only when an intent, contract, or spec states it.
A test citing the code's own documentation is re-cited to the
sentence that decides its value, kept as `mutant` when it alone
catches a fault, or deleted, and test-pruner records it as
self-derived so the pass flags it for removal.

Changelog: ignore

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@CBenoit

Copy link
Copy Markdown
Member Author

Lines changed (added/removed):

Area Lines
Production code 0
Tests 0
Other (agent skills) +5 / -3

ci/check-oracle-markers.ps1 is unchanged: it checks marker syntax and resolution, not whether a source decides a value, so a reference citing the crate under test is left to review.

Note

Human-tuned, LLM-assisted content.

@CBenoit
Benoît Cortier (CBenoit) merged commit a66a019 into master Oct 27, 2026
54 checks passed
@CBenoit
Benoît Cortier (CBenoit) deleted the chore/oracle-own-docs-not-reference branch October 27, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant