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

+1 -1
View File
@@ -1,6 +1,6 @@
# License
paperspec is not under Scienting's usual license.
PaperSpec is not under Scienting's usual license.
Because the formats are meant to be implemented by anyone, in any product, without asking, each path of the repository keeps the license that `LICENSE.md` gives it.
| Paths | License | SPDX |
+1 -1
View File
@@ -1,6 +1,6 @@
# Check and rebuild the repository
Four commands work on a checkout of the paperspec repository, not on an installed package: `check`, `build`, `stress` and `site`.
Four commands work on a checkout of the PaperSpec repository, not on an installed package: `check`, `build`, `stress` and `site`.
The checkout is the one an editable install points at, or else the one around the current folder.
## Check everything
+2 -2
View File
@@ -1,6 +1,6 @@
# paperspec
# PaperSpec
paperspec is the reference implementation of the scienting formats, the files in which a team stores its scientific papers once, corrects them once and addresses them down to the sentence.
PaperSpec is the reference implementation of the scienting formats, the files in which a team stores its scientific papers once, corrects them once and addresses them down to the sentence.
This site documents the Python package `paperspec` and its command.
The formats themselves, with the specification, schemas, test vectors and fixtures, are published at <https://paperspec.scient.ing>.
+2 -2
View File
@@ -60,7 +60,7 @@ A rule that is broken raises `tree.Refusal`, whose `rule` attribute names the ru
| --- | --- | --- |
| `rights` | Rights records, policies and stage checks. | `effective`, `combine`, `check`, `backend_allowed` |
| `layers` | What every annotation shares: its record ID, its anchors and the lists its fields take. | `annotation_id`, `anchors_of`, `BODY_KINDS`, `CATEGORIES`, `VERDICTS`, `STATUSES` |
| `claims` | References to paperclaim claims and their pins. | `parse_ref`, `parse_pin`, `format_ref`, `format_pin` |
| `claims` | References to PaperClaim claims and their pins. | `parse_ref`, `parse_pin`, `format_ref`, `format_pin` |
| `traces` | Traced citations. | `resolve`, `problems`, `disputed` |
| `structures` | Chemical structures tied to words. | `scan`, `problems` |
| `sequences` | Biological sequences tied to words. | `residues`, `problems` |
@@ -92,7 +92,7 @@ A proposal the gate refuses raises `revision.Refused`, with the proposal's `inde
## Math forms
`package.validate` reports `doc.math.form` for a source with `form` that is not the form's own spelling ([spec/03 §3.7](https://paperspec.scient.ing/spec/03-nodes.html#37-math-forms)).
Without help it knows only what `scienting-math/1` never holds, a `\tag`, `\label`, `\nonumber`, `\notag`, style command, `\dfrac` or `\tfrac`; with papermath installed it spells every source again and requires it back unchanged.
Without help it knows only what `scienting-math/1` never holds, a `\tag`, `\label`, `\nonumber`, `\notag`, style command, `\dfrac` or `\tfrac`; with PaperMath installed it spells every source again and requires it back unchanged.
Pass `forms={}` to check only the first, or a mapping from a form to a function that spells a source in it.
## The command