Repository navigation
docs: Document every change since 0.1.1 with checked examples - #39
Merged
Merged
Conversation
…d examples that are errors.
…ls, with examples.
This was referenced Oct 20, 2026
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.
The 25 changes merged since 0.1.1 (#14 to #38) were documented in
DESIGN.mdandARCHITECTURE.md, but on the website mostly by a sentence each, often only in the limitations page, and none in the release notes. This documents each one where a user looks for it, with a complete example and the output the verifier prints, and starts the 0.2.0 release notes.language/syntax.rst&&, and that 0.1.1 verified only the first conditionlanguage/expressions.rstlanguage/ghost-proofs.rst2147483647 + 1read through a spec is negativelanguage/integers.rstlanguage/pointers.rstUnresolved, what to write instead, and a read through a reference before any write; two null pointers differ by 0language/dynamic-storage.rstnewlanguage/functions-loops.rstdo { } while (0)macros); what templates and member functions do todaylanguage/limitations.rstlanguage/tooling.rstencoding.failed,--jobs, cvc5 1.4, clang-format, and the constructs in Clang's own toolschoosechecked as recursion (0.1.1 verified a false claim with it); why a downgraded result is not[vacuous]; a pointer to the replay examplerelease-notes.rstEvery output on these pages is checked.
check-doc-examples.pynow also compares the errors and warnings a page shows after an example, apart from the location before each, and checks examples marked.. cppverify-example: rejects, whichcpp-verifymust report as an error. A#line 1before each example makes a location inside a message count from the example's first line, as the reader sees it. Each of these makes the check fail: a shown error or warning with a changed word, an error example withoutrejects, andrejectson code that verifies. The existing pages all pass the stricter check.Writing the pages also turned up one sentence that contradicted #18 (
pointers.rstcalled null operands of a pointer difference "fail closed"); it now says which cases fail with a counterexample and which stop the file. The options section lists what is checked today: a Lean export still accepts the solver budgets it does not use, which a separate change fixes.Testing:
docs_examples.testchecks 191 examples (43 against the output their pages show), 0 failed;docs_coverage.testpasses;sphinx-build -Wbuilds the site without warnings.