Repository navigation
Rewrite four crate READMEs that were mangled by a hard wrap - #101
Merged
Merged
Conversation
7 of 8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-storenow says why a correction is a new row rather than an edit, which is what makes the published losses rule mean anything.bench-reportnow 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-corpusnow 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-clihad one sentence. It now lists what the tool does, says plainly thatrun,reproduceandreportare 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
clickbenchsubcommand enum still called it two halves, and it has had three sincecalibratelanded in #98.