docs: name the real engine update export - #84
Merged
Conversation
`text_update` does not exist. The engine exports sixteen `pmndrs_glyph_engine_*` symbols and the update entry point is `pmndrs_glyph_engine_update`; the old name survived the rename only in prose. `README.md:315` routes anyone integrating a non-Three renderer at `rust-layout-engine.md`, which carried twelve of the stale references, so this is the first thing an external integrator would search for and fail to find. Two sites were also wrong about the signature, not just the name. `glyph.md:98` and `core-api.md:214` both documented `text_update(requestOffset, requestLength)`, omitting the `session_id` argument the export actually takes. Both now carry the real three-argument form. `rust-layout-engine.md:275` already had the arity right and only the name wrong. Both sites also called it "the single export" for retained engine sessions, which is false with sixteen exports. They now say the single *mutating* update export, which is accurate and agrees with `glyph.md:260`, where the same document already described `pmndrs_glyph_engine_measure_paragraph` as a query beside `pmndrs_glyph_engine_update`. The twenty remaining occurrences in `decision-register.md` and `log.md` are left alone. Those are past-tense records carrying byte counts from their own era; rewriting them would make the register misreport what was measured when.
size-limit report 📦
|
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
1 participant
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.
text_updatedoes not exist. The engine exports sixteenpmndrs_glyph_engine_*symbols and the update entry point ispmndrs_glyph_engine_update— the old name survived the rename only in prose.This lands on the integrator we most want to keep:
README.md:315routes anyone building a non-Three renderer atrust-layout-engine.md, which carried twelve of the stale references. It is the first symbol they would search for, and it is not there.Wrong on arity, not just the name
Two sites documented a two-argument call:
The real export takes three:
Both now carry the real form.
rust-layout-engine.md:275already had the arity right and only the name wrong."The single export" was also false
Both prose sites called it the single export for retained engine sessions. There are sixteen. They now say the single mutating update export, which is accurate and agrees with
glyph.md:260— where the same document already describedpmndrs_glyph_engine_measure_paragraphas "a paragraph-scoped synchronous query besidepmndrs_glyph_engine_update". The doc had been contradicting itself 162 lines apart.What changed, and what deliberately did not
planning/rust-layout-engine.mdpackages/glyph.md:98prose claimplanning/dirty-range-upload-research.mdplanning/core-api.md:214prose claimplanning/three-api.mdpackages/benchmarks.mdplanning/decision-register.mdlog.mdThe twenty occurrences in the decision register and the log stay. Those rows are past-tense records carrying byte counts from their own era (D-173, D-174, D-175 and neighbours); rewriting them would make the register misreport what was measured when. If the rename needs recording there, it belongs as a new row, not an edit to old ones.
dirty-range-upload-research.mdwas the judgment call. Its three uses are present-tense architectural claims — "never crosstext_update", "never seen bytext_update", "Capture per update:text_update, …" — describing the current boundary rather than recording a measurement, so they are live contract and were fixed.Verification
pnpm check— exit 0, OKF 0 errors / 0 warningsgrep -rc text_update docs/— onlydecision-register.md(11) andlog.md(9) remain, both intentionalpackages/orapps/before and after; no source referenced the stale nameDocs-only, so no
source_digestmoved — the digest covers package source, not documentation.