Add ClearProse - #27
Open
adamtheturtle wants to merge 1 commit into
Open
Conversation
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.
Adds ClearProse, a small style package for reStructuredText.
It contains one rule,
ClearProse.NoEmDash, which reports the Unicode em dash (U+2014) as an error in prose.Relationship to existing packages
RedHat.EmDashalready prohibits em dashes, so it is worth saying where this differs rather than leaving you to find out.That rule sets
scope: raw, so it matches the source text rather than the parsed document. In reStructuredText that means it reports em dashes inside code blocks and inline literals. Run against this package's fixtures, it reports 14 alerts in the two files that hold em dashes in code, whereClearProse.NoEmDashreports none. It is also a warning rather than an error, and it arrives as one rule among 37 in a style guide written for Red Hat documentation.Google.EmDashandMicrosoft.Dashesmatch\s[—–]\sand ask for the spaces to be closed up. They permit the em dash itself, so neither conflicts with this rule.Checks
Run locally before opening this:
pytest testspasses (valid JSON, alphabetical order, required keys, workinghomepageandurl).ClearProse.zipdownloads fromreleases/latest, contains a singleClearProse/directory, and loads into Vale with exit 0.The archive is built reproducibly by a release workflow and is byte-identical across the release assets and a local build. The package repository has its own CI that runs fixture tests against a pinned Vale, and is MIT licensed.