docs(rtl): make the extractor table say what NORM and TRIM do - #8
Merged
Conversation
The RTL reference described `TRIM` as "Trim" -- a tautology -- and `NORM` as "Collapse whitespace", which is incomplete: norm_whitespace strips the edges too, so NORM is strictly stronger than TRIM rather than orthogonal to it. Both rows now match the wording docs/model/atp.md already used for the same extractors, and the "only" in TRIM's row carries the contrast. This table is also the source of the rtl-lsp hover dictionary (vscode-rtl/tools/gen_hover_data.py harvests it), so the extension showed "TRIM -> Trim" as its tooltip. Regenerating there now yields something useful; that regeneration belongs to the vscode-rtl side. Deliberately not cross-referencing the delimited specification here: TRIM applies to any atom, and it is the "Semantics of S_delim" section that points at the extractor, not the other way round. Also fixes an in-page link added in 0.5.0: the anchor for "Atomic -- contSpec" is `#atomic-contspec` under mkdocs, not the GitHub-style `#atomic--contspec` carried over from the jRegTab wording. `mkdocs build --strict` reported it as an unresolved anchor. No behaviour change; documentation only. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Documentation only — no behaviour change, no version bump.
The extractor table
NORMTRIMTRIM's cell defined the extractor as itself.NORM's was incomplete:norm_whitespaceisjava_stripplus run collapsing, soNORMis strictly stronger thanTRIMrather than orthogonal to it — the old table gave the opposite impression. Both rows now match whatdocs/model/atp.mdalready said for the same extractors, and the "only" inTRIM's row carries the contrast.This table is also the source of the
rtl-lsphover dictionary —vscode-rtl/tools/gen_hover_data.pyharvests it — so the VS Code extension was showingTRIM → Trimas its tooltip. Verified: regenerating against this branch changes exactly those two hover entries and nothing else. That regeneration belongs to the vscode-rtl side and is not part of this PR.Deliberately not adding a cross-reference to the delimited specification here.
TRIMapplies to any atom — atomic cells, compound segments and delimited tokens alike — and singling out delimited use would invert the relationship: it is the "Semantics of S_delim" section that points at the extractor. It would also be misleading, since=NORMtrims just as well, and would break the register of a table whose every other row is a bare effect phrase.Broken anchor from 0.5.0
mkdocs build --strictreported:The link was added in the 0.5.0 S_delim work, carried over from the jRegTab wording where GitHub's slugifier produces a double hyphen. The docs here are published with mkdocs, which renders
### Atomic — contSpecasid="atomic-contspec". Fixed; the build no longer reports it.🤖 Generated with Claude Code