Skip to content

Rewrite four crate READMEs that were mangled by a hard wrap - #101

Merged
tamnd merged 1 commit into
mainfrom
docs/crate-readmes
Sep 6, 2026
Merged

tamnd merged 1 commit into
mainfrom
docs/crate-readmes

Conversation

@tamnd

@tamnd tamnd commented Sep 6, 2026

Copy link
Copy Markdown
Owner

Four of the crate READMEs had a blank line between every wrapped fragment, so a paragraph rendered as a list of half sentences. The house style is one unwrapped line per paragraph and these four were not that.

While fixing the wrapping I filled them in, because three of them said less than the crate does and one of them said almost nothing at all.

bench-store now says why a correction is a new row rather than an edit, which is what makes the published losses rule mean anything.

bench-report now says what the rules that stop a misleading table actually are, since naming them is the whole reason they are code in a crate rather than editorial policy.

bench-corpus now covers the checks that run after the digest and the rule about generated corpora being pinned to the platforms they have been produced on, which was in the top level README and not here.

iris-bench-cli had one sentence. It now lists what the tool does, says plainly that run, reproduce and report are named and do nothing yet, and says why the things that would be tempting to default are arguments that end up in the record instead.

One code change came with it. The doc comment on the clickbench subcommand enum still called it two halves, and it has had three since calibrate landed in #98.

@tamnd tamnd added the type: docs Documentation, specifications and written method label Sep 6, 2026
@tamnd
tamnd merged commit 0e41c0c into main Sep 6, 2026
15 of 17 checks passed
@tamnd
tamnd deleted the docs/crate-readmes branch September 6, 2026 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Documentation, specifications and written method

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant