diff --git a/CHANGELOG.md b/CHANGELOG.md index f97450d..cf6d551 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,7 +38,7 @@ Packaging, commands and lazy imports only; the formats stay at 0.1.0, and no com ### Unreleased -Two changes asked for by the first producer that compares a converted reading with a second witness (paperform with a JATS file). +Two changes asked for by the first producer that compares a converted reading with a second witness (paperforms with a JATS file). Both are minor changes in the sense of [spec/00](spec/00-introduction.md): no valid file becomes invalid, and no hash, ID or key changes; the next release numbers them. - Alignment has a substitution step ([spec/05 §5.6](spec/05-hashes.md#56-alignment), step 3): in each stretch between pairs, an unpaired sentence of the first reading is paired with the first unpaired sentence of the second whose similarity (2*L* / (|*a*| + |*b*|) over code points of the lossy projections, *L* their longest common subsequence) is at least 0.8, both of prose length 20 or more. @@ -154,13 +154,13 @@ Tooling and code quality only; no computed value, vector, fixture, schema or SQL - Python files open with an `SPDX-License-Identifier: Apache-2.0` header, which ruff and a test check. - The checker and the site builder skip `work/`, caches and build output. -One more, the work the other paper tools planned for paperspec (paperdesk's plan, item M5.4, and paperform's, §4.2): a command that applies corrections, two checks the validator had left to producers, and public names for what the tools had been importing as private ones. +One more, the work the other paper tools planned for paperspec (paperdesk's plan, item M5.4, and paperforms's, §4.2): a command that applies corrections, two checks the validator had left to producers, and public names for what the tools had been importing as private ones. It is a minor change in the sense of [spec/00](spec/00-introduction.md): new rules, functions and a command, with no fixture package made invalid and no computed value changed. - `paperspec correct` and `paperspec.revision` apply proposed corrections to a package, a folder or a zip, through the gate ([spec/11](spec/11-corrections.md)), and write the package they make, in place or to `--out`, only once it validates. A changed leaf becomes F1 when a crop of it is the evidence and F0 otherwise ([spec/08 §8.1](spec/08-fidelity.md#81-levels-of-fidelity)), and an `emend`, `relink` or `resolve` keeps its level. A retired node's locations move to its successor, suspects at removed nodes and those named by `--answered` are dropped, derived lines and datasets that read the corrected text are left out and reported, and provenance gains a `review` stage. - With no corrections it writes every example package and every valid package of paperform's bench back byte for byte (`test_revision.py`, `test_cli_correct.py`). + With no corrections it writes every example package and every valid package of paperforms's bench back byte for byte (`test_revision.py`, `test_cli_correct.py`). - `doc.math.form` is checked ([spec/03 §3.7](spec/03-nodes.md#37-math-forms)). The validator refuses a source in the form that holds a label or style command the form never holds, such as `\tag`, `\label`, `\nonumber`, `\displaystyle` or `\dfrac`. When papermath is installed, or a caller passes `forms=`, it also refuses a source that is not the form's own spelling or that the form cannot read (`test_math_form.py`). diff --git a/tests/test_revision.py b/tests/test_revision.py index 86d630a..d33530b 100644 --- a/tests/test_revision.py +++ b/tests/test_revision.py @@ -362,7 +362,7 @@ def test_summarize_recomputes_what_document_json_derives_from_the_nodes(): def test_a_live_nodes_records_for_one_page_are_kept_as_the_package_gave_them(tmp_path): - # paperform writes a block's approximate box and its glyph boxes as two records of one + # paperforms writes a block's approximate box and its glyph boxes as two records of one # page; the writer leaves what it was not asked to change alone. locs = records(HALE, "locations.jsonl") first = next(loc for loc in locs if loc["node"] == "mhp0at8") diff --git a/tools/README.md b/tools/README.md index 98de355..1da39ca 100644 --- a/tools/README.md +++ b/tools/README.md @@ -76,7 +76,7 @@ A node's five values depend only on its own subtree, so after a correction the o `paperspec check` compares the result after every correction with a slow computation that projects each node from its whole subtree. Other repositories of the project do not reimplement the specification: they install this repository as the Python package `paperspec`, from the Gitea package registry or as a git pin ([deploy/](../deploy/README.md#install-from-the-registry)), and import the oracle from it, so that every key, identifier, canonical JSON string, package check and database form comes from one piece of code. -paperstack, paperform, paperdesk and paperclaim import it, and paperchem, paperbio and paperdata test their annotation bodies against it. +paperstack, paperforms, paperdesk and paperclaim import it, and paperchem, paperbio and paperdata test their annotation bodies against it. The library surface they use is `keys`, `text`, `jcs`, `hashing`, `tree`, `anchors`, `package`, `revision`, `corrections`, `db`, `schema`, `fingerprint`, `rights`, `layers`, `claims`, `traces`, `structures`, `sequences` and `data`, with the schemas, SQL, vectors, registries and JSON-LD context as package data: `paperspec.resources.path("sql")` finds a folder in an installed wheel and in an editable install alike. The vectors travel with the package, but `resolve.jsonl`, `grading.jsonl`, `targets.jsonl` and `traces.jsonl` name a fixture package, and the fixtures stay in the repository, where `paperspec.resources.path("fixtures")` finds them in a checkout or an editable install. The package needs Python 3.14, the only version with the Unicode 16.0 character data the specification pins, and refuses to import on any other.