docs(validation): state what --offline pins and what nothing pins - #149
Open
LukasGold wants to merge 1 commit into
Open
docs(validation): state what --offline pins and what nothing pins#149LukasGold wants to merge 1 commit into
LukasGold wants to merge 1 commit into
Conversation
- the vendored meta-schemas are byte-exact; a document's @context is not - offline defaults to false, so two runs can disagree if a context moves - say why make validate passes --offline
5 tasks
Contributor
Release previewNo version bump from the current commits (stays at Changelog preview (truncated)Preview via python-semantic-release and conventional commits. |
Contributor
📊 Benchmark ResultsClick to see benchmark comparisonThreshold: 1.3x (30% slower triggers a regression warning) Note: Benchmarks are informational only and won't fail the build. 💡 Tip: Download the |
19 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Closes the last open item of #125.
Item 5 was written as "default
make validateto--offline, or state the asymmetry". Half of it was never a gap:make validatehas passed--offlinesince80ee29a, the commit that added the validator. So the remaining work was only ever the documentation, which this is.The asymmetry
The vendored meta-schemas exist so that a released version cannot change meaning between runs, and
docs/how-to/validation.mdsays so. A document's@contexthas no equivalent guarantee, and the options table gave--offlineone line, "Never fetch; use local files and the cache only", which describes the mechanism without saying why anyone would want it.offlinedefaults to false because that is what lets a cross-directory or genuinely remote@contextresolve at all. It is the point rather than an oversight. But it also means two runs over the same document can disagree if a context it reaches for has moved in between, which sits oddly next to the reproducibility the vendored copies are there to provide.The new section states both halves and explains why
make validatepasses the flag: the committed fixtures are supposed to give the same answer today and next year.Documentation only. No behaviour changes, and nothing was renamed or defaulted differently.
Verification
make docs-test: exit 0, no issues, which is the strict build that fails on any warningmake check: clean