Repository navigation
Adds a value domain and evaluation options page - #212
Merged
Merged
Conversation
A reference page under docs/reference: the eleven members of the value domain and their TypeScript shapes, the member classes and helpers, what each host value normalizes to or is refused with, the refusal reasons and their limits, the integer rule for literal operands, the plain projection back to host values, and every evaluation option with its type, default and effect, including the tagged request. The README's two sections on these subjects become one-line links to the page, its Documentation map links the page under Look up in place of the two section lines, and the three guides that linked the sections link the page. Refs: pts-v2nr
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.
Why
The README carried the value domain and the evaluation options as two sections of its long reference tail. A reader looking up a member's TypeScript shape, what the host boundary refuses, or an option's default had to find them inside that tail, and neither section listed every export, every refusal reason or every option type.
What
docs/reference/the-value-domain-and-evaluation-options.md, titled "The value domain and evaluation options" (the title the bead names). It describes, in tables: the members and their TypeScript shapes; the member classes and helpers; what each host value normalizes to or is refused with; the refusal reasons and the depth and place limits; the integer rule forlitoperands and thecastexemption; the plain projection back to host values; which functions take options; everyEvaluateOptionsmember with its type, default and effect; andTaggedEvaluateOptions.nowandrandomoptions links the page.how-to-add-host-functions.md,how-to-compile-and-evaluate-a-rule.mdandhow-to-run-a-statement-program.md(one link each).No file under
src/changes. No changelog fragment:changelog.d/README.mdexcludes documentation.Source
Written from the README's two sections and the declarations in
src/values.ts,src/evaluator.ts,src/context.tsandsrc/tagged.ts; the docs audit's next action for this repository names a different subject (the Install section), so no audited span was cut. Every claim the README sections made is on the page except the sentence that a value type the domain lacks is raised upstream rather than added here, which is rationale and stays in ADR-0002.Checks
mise exec -- pnpm run gate) green on the branch head; the README is a gated path.README.md: 1079 lines, every part present.litexample in the integers table and thetypeNameand normalization rows, and every result matched. The behaviour rows on unbound loads, the clock and host-function failures were also checked against the build.Provenance
The guide link updates are outside the bead's file map and are forced by the moved sections. The page's paragraphs on unbound loads and on a throwing
nowdescribe what the build does, checked by execution: under the default policy a type mismatch over an unbound absence is reported as an unbound-variable error inexecutetoo, and a throwingnowread byDate.now()comes back on the failing arm while one read by a relative date propagates.Closes pts-v2nr.