docs: the tools' names in TitleCase

Prose names are PaperSpec, PaperDesk, PaperClaim and so on; commands, packages and paths stay lowercase.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014zNf4shD4zaCKLucZWPYL9
This commit is contained in:
alexmandClaude committed 2026-10-21 09:49:58 -04:00
1 parent 105896a18b
commit 03b4722023
24 files changed
+111 -111

No files matched your search

+14 -14
View File
@@ -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 (paperforms 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.
@@ -62,7 +62,7 @@ They are minor changes too: new operations, enumeration values and optional prop
- The rules `correction.emend`, `correction.relink`, `correction.resolve` and `doc.correction.resolution` are registered, the `corrections` table's CHECK takes the three operations ([sql/doc.sql](sql/doc.sql)), `corrections.State` carries the reference records, and `paperspec stress` walks the three operations with their invariants.
`corrections.jsonl` gains thirteen cases and `projections.jsonl` and `projection-groups.jsonl` two each; no existing case changes.
Four more, asked for by papermath, which defines the math form `scienting-math/1`, and by paperclaim, the claim store whose claims and symbols layers point at.
Four more, asked for by PaperMath, which defines the math form `scienting-math/1`, and by PaperClaim, the claim store whose claims and symbols layers point at.
The first two are minor changes: an optional property, a derived file and its schema, with no hash, ID or key of an existing file changed.
The last two make some files that were valid invalid, which [spec/00](spec/00-introduction.md) calls breaking; they are made now because no release of `scienting-doc/1` or `scienting-layer/1` has been tagged, and a reference worth changing is changed before one is ([CONTRIBUTING.md](CONTRIBUTING.md#releasing), item 4).
@@ -71,14 +71,14 @@ The last two make some files that were valid invalid, which [spec/00](spec/00-in
`form` enters no content value ([spec/05 §5.2](spec/05-hashes.md#52-own-content)): own content leaves it out of math runs (`paperspec.hashing`), an equation's own content never held more than its notation and source, and no projection reads it, so adding `form` to a source already in the form changes no hash, ID or anchor, while respelling a source changes it as any edit does.
Because a complex formula's key compares sources, a producer aligning a reading in a form with another reading respells the other's math first.
`hashes.jsonl` gains a case, `math-form`, whose values `paperspec check` also computes without `form`; the rule `doc.math.form` is registered for validators that implement the form, which the reference validator now does in part (see the last section).
- `derived/math.jsonl` ([spec/12 §12.7](spec/12-package.md#127-derived-files), [spec/09 §9.4](spec/09-figures-tables-equations.md#94-the-math-form), `math.schema.json`): one line per formula, `{node, run, tool, form, tree, symbols, complete, issues, label?}`, papermath's reading without the canonical TeX, which is the source; `run` is null for an equation, as in `derived/mathml.jsonl`, and `label` is omitted when the source has no `\tag`.
- `derived/math.jsonl` ([spec/12 §12.7](spec/12-package.md#127-derived-files), [spec/09 §9.4](spec/09-figures-tables-equations.md#94-the-math-form), `math.schema.json`): one line per formula, `{node, run, tool, form, tree, symbols, complete, issues, label?}`, PaperMath's reading without the canonical TeX, which is the source; `run` is null for an equation, as in `derived/mathml.jsonl`, and `label` is omitted when the source has no `\tag`.
A tree node is an array whose first item is its kind; the schema takes any lowercase kind and issue code, so the form can add some in a minor version, and lists the 49 kinds and six codes of version 1.
The validator now checks derived files: each line against its schema, that it names a formula of the package (`doc.derived.node`), that a math line's formula is TeX and its `complete` and `symbols` agree with its tree (`doc.derived.math`), and that a checks-only package carries none (`doc.policy.withheld`), since a tree or MathML reads the withheld text.
The main example gains `derived/math.jsonl`, papermath 0.1.0's reading of its equation and of two math runs, copied by hand because the oracle does not implement the form; `paperspec check` validates fourteen variants of it, and no fixture's hashes change.
The main example gains `derived/math.jsonl`, PaperMath 0.1.0's reading of its equation and of two math runs, copied by hand because the oracle does not implement the form; `paperspec check` validates fourteen variants of it, and no fixture's hashes change.
There are now 43 schemas, which the 0.1.0 entry above, held to the repository by `paperspec check`, states too.
- Claim references ([spec/18 §18.4](spec/18-layers.md#184-bodies), [spec/02 §2.4](spec/02-model.md#24-work-and-document-keys), [spec/20](spec/20-projects.md), `claimRef` and `claimPin` in `common.schema.json`): the `source` of a `claim-link` or `symbol` body, a `claim:` identifier in `same_as`, and a project's claim step are paperclaim references, `claim:<tag>` or `claim:<host>/<tag>` with the tag eight Crockford base32 capitals, and a `pin` is the reference, `@` and six lowercase hex digits of the claim's statement hash, as paperclaim writes them; a project names its claim namespace as `claims.paperclaim`.
A reference by slug, such as `amber/k-bond`, which paperclaim may rename, or under any other prefix, was valid before and is not now.
The fixtures' slug reference and `illustrative-pin` become `claim:272XTX7C` and `claim:272XTX7C@02f47b`, the claim `amber/k-bond` of paperclaim's example store, which changes the claim link's and the symbol's record IDs, the layer receipt and `project.json`.
- Claim references ([spec/18 §18.4](spec/18-layers.md#184-bodies), [spec/02 §2.4](spec/02-model.md#24-work-and-document-keys), [spec/20](spec/20-projects.md), `claimRef` and `claimPin` in `common.schema.json`): the `source` of a `claim-link` or `symbol` body, a `claim:` identifier in `same_as`, and a project's claim step are PaperClaim references, `claim:<tag>` or `claim:<host>/<tag>` with the tag eight Crockford base32 capitals, and a `pin` is the reference, `@` and six lowercase hex digits of the claim's statement hash, as PaperClaim writes them; a project names its claim namespace as `claims.paperclaim`.
A reference by slug, such as `amber/k-bond`, which PaperClaim may rename, or under any other prefix, was valid before and is not now.
The fixtures' slug reference and `illustrative-pin` become `claim:272XTX7C` and `claim:272XTX7C@02f47b`, the claim `amber/k-bond` of PaperClaim's example store, which changes the claim link's and the symbol's record IDs, the layer receipt and `project.json`.
The main example's two targeted receipts take the scope `targeted:paperclaim`, which changes their IDs and signatures, Ben's spot-check of the second (its seed and its sample of ten, still without errors), the QA report, the inclusion proof, the transparency log's checkpoint and tiles, and the signature, spot-check, VRF and checkpoint vectors built from them; no node's level or the report's counts change.
- Symbol keys ([spec/18 §18.4](spec/18-layers.md#184-bodies), `annotation.schema.json`, the `key` term of the JSON-LD context, `sct:symbolKey`): a `symbol` body names its symbol by `key`, its `scienting-math/1` key, besides the span its target selects, so a symbol is found across papers and matched to its claim by key; a `symbol` body without `key` was valid before and is not now.
The example layer gains a proposed symbol annotation on `$K_r$`, with the key `K_{r}`.
@@ -88,7 +88,7 @@ The last two make some files that were valid invalid, which [spec/00](spec/00-in
The third was the stress harness's own: a truncation could cut a file at its full length, leaving the package unchanged and valid, so it now always shortens the file.
So was a fourth, with 1000 rounds: the random walk of corrections could delete the body section, leaving nothing to correct and too few corrections accepted, so a delete now leaves at least eight nodes.
One more, asked for by paperdesk, which lets a reader follow a citation to the passage it rests on.
One more, asked for by PaperDesk, which lets a reader follow a citation to the passage it rests on.
It is a minor change in the sense of [spec/00](spec/00-introduction.md): a new body kind, optional properties and two rules, with no valid file made invalid, no computed value changed and no existing vector case or package changed.
- Traced citations ([spec/18 §18.5](spec/18-layers.md#185-traced-citations), `annotation.schema.json`, the `note` and `proposer` terms of the JSON-LD context): a `trace` body follows one citation of a sentence of a citing paper to a passage of the cited paper.
@@ -103,7 +103,7 @@ It is a minor change in the sense of [spec/00](spec/00-introduction.md): a new b
`paperspec check` runs both layers through the record checks and the store.
The example project holds the new layer, which changes `project.json`; no other fixture changes.
One more, asked for by paperchem and paperbio, which tie molecules and sequences to the words of a paper.
One more, asked for by PaperChem and PaperBio, which tie molecules and sequences to the words of a paper.
It is a minor change in the sense of [spec/00](spec/00-introduction.md): two new body kinds, optional properties and seven rules, with no valid file made invalid and no computed value changed; the example layers, the traces and every receipt are as they were.
- Chemical structures ([spec/18 §18.6](spec/18-layers.md#186-chemical-structures), `annotation.schema.json`): a `structure` body ties a SMILES or SMARTS to a span, with a `role` (`names`, `depicts`, `parametrizes` or `uses`), an `identity` that finds the same structure however it was written (the InChIKey of a SMILES, else `smiles:` or `smarts:` and twelve hex digits of the SHA-256 of the value), the paper's own `written` notation, a `label`, outside `accessions` and `terms`: the bonds, angles, torsions and impropers a paper gives constants for.
@@ -122,7 +122,7 @@ It is a minor change in the sense of [spec/00](spec/00-introduction.md): two new
The draft gains a last sentence, which the biology layer is about, so the draft package, its draft IDs and the one traces vector that anchors its paragraph change; the traces layer's anchors, its receipt and every other vector are as they were.
- The prose check's UK spelling pattern no longer takes `organism` for a form of `organise`.
One more, asked for by paperdata, which finds data by its kind and by the molecules and sequences it is about.
One more, asked for by PaperData, which finds data by its kind and by the molecules and sequences it is about.
It is a minor change in the sense of [spec/00](spec/00-introduction.md): one new body kind, optional properties and four rules, with no valid file made invalid and no computed value changed; the other layers, the traces and every receipt are as they were.
- Data ([spec/18 §18.8](spec/18-layers.md#188-data), `annotation.schema.json`): a `data` body says what kind of data a span presents, with a `data_type` from a fixed list of fifteen, a `role` (`reports` or `uses`), the `dataset` that holds the values, the `quantities` its fields measure (a field, a name and the dataset's unit), the `subjects` it is about (the identities of `structure` and `sequence` bodies), a `method`, a `label` and outside `accessions`, so that a term of an ontology can say more than the list does.
@@ -154,16 +154,16 @@ 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 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.
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 paperforms'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`).
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`).
- The validator checks a package's datasets ([spec/15](spec/15-datasets.md), `paperspec.datasets`): the descriptor against its schema, the folder named by the ID, a unique primary key, each value anchor resolving as current to the text the CSV holds, and every numeric value of a reported resource anchored.
These are the rules `doc.dataset.schema`, `.id`, `.file`, `.key`, `.anchor`, `.value` and `.unanchored` (`test_datasets.py`).
- `fixtures/invalid/` gains `suspect-witness` and `math-form-label`, so there are 33 broken packages, which the 0.1.0 entry above states too (`paperspec check`).
@@ -172,4 +172,4 @@ It is a minor change in the sense of [spec/00](spec/00-introduction.md): new rul
- Public names, with the old private names kept as aliases: `package.parse_canonical`, `parse_json`, `parse_jsonl`, `check_zip_entries` and `read_zip_files`; `tree.flatten` and `establish_with_side`, which keeps a producer's private keys; `hashing.strict_runs`; and `corrections.OPS` and `EMEND_KINDS` (`test_public_api.py`).
Also `anchors.follow` and `resolve_address`, `claims.parse_ref`, `parse_pin`, `format_ref` and `format_pin`, `layers.annotation_id`, `anchors_of` and the lists of body kinds, categories, verdicts and statuses, and `db.load_layer`, `read_state`, `delete` and `upgrade` (`test_anchors.py`, `test_claims.py`, `test_layers.py`, `test_db.py`).
- `text.collapse_ws`, `trim`, `remove_ws` and `digits` and `hashing.lossy_from_strict` are rewritten for speed, so a correction goes through the gate about three times faster, and are tested equal to the old code on every code point (`test_text.py`, `test_hashing.py`).
- The private aliases kept for the siblings are gone, now that paperdesk and paperforms use the public names: `package._canonical_bytes`, `package._zip_entries`, `anchors._follow` and `traces._anchors` (`tests/test_public_api.py::test_parse_canonical_reads_doubles_and_refuses_what_is_not_canonical`, `::test_check_zip_entries_returns_the_folder_without_reading`, `tests/test_anchors.py::TestFollow::test_follow_has_no_alias_under_its_old_private_name`).
- The private aliases kept for the siblings are gone, now that PaperDesk and PaperForms use the public names: `package._canonical_bytes`, `package._zip_entries`, `anchors._follow` and `traces._anchors` (`tests/test_public_api.py::test_parse_canonical_reads_doubles_and_refuses_what_is_not_canonical`, `::test_check_zip_entries_returns_the_folder_without_reading`, `tests/test_anchors.py::TestFollow::test_follow_has_no_alias_under_its_old_private_name`).