3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-20 23:25:43 +01:00

Answer prose round 1: item 72 waits on the rest of 0.2.0, item 77 counts its values; answer product-owner round 1: link the goals the quick start serves

This commit is contained in:
2026-10-05 08:58:54 +02:00
committed by Lillem4n
parent e7a1aa1194
commit 4d4f292fbe
2 changed files with 13 additions and 11 deletions
+1 -1
View File
@@ -48,7 +48,7 @@ if (result.ok) {
} }
``` ```
Serves Goals 1, 2 and 8. Pure functions, each taking a whole document and returning a whole Serves [Goals](#goals) 1, 2 and 8. Pure functions, each taking a whole document and returning a whole
result; no I/O, no configuration. `markdownToHtml` and `htmlToMarkdown` convert through ADF: result; no I/O, no configuration. `markdownToHtml` and `htmlToMarkdown` convert through ADF:
they keep only what ADF holds, and refuse what `markdownToAdf` or `htmlToAdf` refuses. they keep only what ADF holds, and refuse what `markdownToAdf` or `htmlToAdf` refuses.
+12 -10
View File
@@ -113,9 +113,11 @@ accessor property, or a Proxy trap that throws, is `not-an-adf-document`. The co
enumerable keys, as `JSON.stringify` does, so an inherited or non-enumerable key drops. The reader enumerable keys, as `JSON.stringify` does, so an inherited or non-enumerable key drops. The reader
reads arrays by index, so no custom iterator runs. Every later step works on the copy. A Proxy can reads arrays by index, so no custom iterator runs. Every later step works on the copy. A Proxy can
still claim unbounded width, which the 500-level limit does not cover, so the copy reads at most 10 still claim unbounded width, which the 500-level limit does not cover, so the copy reads at most 10
million values (the maintainer, 2026-10-05): roughly 50 to 100 MB of JSON, far past any real page, million JSON values, each object, array, string, number, boolean and null counting one (the
where 10 000 would refuse a 500-row table. Before reading an array, the reader checks its `length` maintainer, 2026-10-05): roughly 50 to 100 MB of JSON, far past any real page, where 10 000 would
against the values left, so a Proxy claiming 2³² elements is refused at once. Found by the refuse a 500-row table. Before reading an array, the reader checks its `length` against the values
left, so a Proxy claiming 2³² elements is refused at once. The code that refusal takes follows
`docs/decisions.md` §Which code a cause takes; where it reads two ways, the chunk asks. Found by the
technical-principles audit, 2026-10-04. technical-principles audit, 2026-10-04.
### 71. Add a README table comparing the package with the other ADF converters, each cell checked against that package's own docs or behaviour. ### 71. Add a README table comparing the package with the other ADF converters, each cell checked against that package's own docs or behaviour.
@@ -205,13 +207,13 @@ of one character from each of its characters.
### 72. Re-create `gitea.larvit.se/larvit/adf-codec` as a read-only pull mirror of GitHub, its issues and Actions off and its description pointing at GitHub. ### 72. Re-create `gitea.larvit.se/larvit/adf-codec` as a read-only pull mirror of GitHub, its issues and Actions off and its description pointing at GitHub.
Lands when `0.2.0` is getting ready to be cut (the maintainer, 2026-10-05). The maintainer does Lands after every other `0.2.0` item (the maintainer, 2026-10-05). The maintainer does this. Gitea
this. Gitea cannot convert an existing repository to a mirror, so cannot convert an existing repository to a mirror, so the copy is deleted and re-created. That drops
the copy is deleted and re-created. That drops the copy's commit hashes from before the 2026-10-04 the copy's commit hashes from before the 2026-10-04 history rewrite, and its Actions secrets. The
history rewrite, and its Actions secrets. The Gitea copy holds no issues or releases to move. Gitea copy holds no issues or releases to move. Actions stay off on the mirror: Gitea runs
Actions stay off on the mirror: Gitea runs `.github/workflows/` when `.gitea/workflows/` is absent, `.github/workflows/` when `.gitea/workflows/` is absent, and the mirrored `publish` job would
and the mirrored `publish` job would otherwise run there. When this lands, the `docs/decisions.md` otherwise run there. When this lands, the `docs/decisions.md` entry "GitHub is canonical" loses its
entry "GitHub is canonical" loses its interim sentence. interim sentence.
### 52. Spell `colwidth` as a comma list, `colwidth="340,420"`. ### 52. Spell `colwidth` as a comma list, `colwidth="340,420"`.