Skip to content

Commit

Permalink
Fix up the list of checks
Browse files Browse the repository at this point in the history
  • Loading branch information
suchow committed Mar 30, 2016
1 parent 1f0640f commit 7eced8f
Show file tree
Hide file tree
Showing 2 changed files with 140 additions and 120 deletions.
130 changes: 70 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,69 +97,79 @@ You can disable any of the checks by modifying `.proselintrc`.

| ID | Description |
| ----- | --------------- |
| `carlin.filth` | Words to avoid |
| `annotations.misc` | Catching annotations left in the text |
| `cliches.hell` | Avoiding a common cliché |
| `cliches.misc` | Avoiding clichés |
| `consistency.spacing` | Consistent sentence spacing |
| `consistency.spelling` | Consistent use of British vs. American spelling |
| `cliches` | Avoiding cliché |
| `garner.airlinese` | Avoiding jargon of the airline industry |
| `garner.am_pm` | Using the right form for the time of day |
| `garner.animal_labels` | Likening things to animals using fun words |
| `garner.archaism` | Avoiding archaic forms |
| `garner.back_formations` | Avoiding needless backformations |
| `garner.capitalization` | Captializing what ought to be capitalized |
| `garner.commercialese` | Avoiding jargon of the commercial world |
| `garner.dates` | Stylish formatting of dates |
| `garner.denizen_labels` | Calling people the right names |
| `garner.diacritical_marks` | Using dïacríticâl marks |
| `garner.illogic` | Avoiding illogical forms |
| `garner.jargon` | Avoiding miscellaneous jargon |
| `garner.malapropisms` | Avoiding common malapropisms |
| `garner.many_a` | Many a singular |
| `garner.misspelling` | Avoiding common misspellings missed by spell-check |
| `garner.mixed_metaphors` | Not mixing metaphors |
| `garner.mondegreens` | Avoiding mondegreens |
| `garner.needless_variants` | Using the preferred form |
| `garner.oxymorons` | Avoiding oxymorons |
| `garner.preferred_forms` | Miscellaneous preferred forms |
| `garner.punctuation` | Using the right punctuation |
| `garner.redundancy` | Avoiding redundancy |
| `garner.sexism` | Avoiding sexist language |
| `gowers.overworked_metaphors` | Overworked metaphors |
| `inc.corporate_speak` | Avoiding corporate buzzwords |
| `leonard.exclamation` | Avoiding hyperbolic use of exclamation |
| `leonard.hell` | Avoiding a common cliché |
| `lilienfeld.terms_to_avoid` | Avoiding misused psychological terms |
| `misc.annotations` | Catching annotations left in the text |
| `consistency.spelling` | Consistent spelling |
| `corporate_speak.misc` | Avoiding corporate buzzwords` |
| `cursing.filth` | Words to avoid |
| `cursing.nfl` | Avoiding words banned by the NFL |
| `dates_times.am_pm` | Using the right form for the time of day |
| `dates_times.dates` | Stylish formatting of dates |
| `hedging.misc` | Not hedging |
| `hyperbole.misc` | Not being hyperbolic |
| `jargon.misc` | Avoiding miscellaneous jargon |
| `lexical_illusions.misc` | Avoiding lexical illusions |
| `links.broken` | Linking only to existing sites |
| `malapropisms.misc` | Avoiding common malapropisms |
| `misc.airlinese` | Avoiding jargon of the airline industry |
| `misc.apologizing` | Being confident |
| `misc.archaism` | Avoiding archaic forms |
| `misc.back_formations` | Avoiding needless backformations |
| `misc.bureaucratese` | Avoiding bureaucratese |
| `misc.but` | Avoid starting a paragraph with "But..." |
| `misc.capitalization` | Capitalizing only what ought to be capitalized |
| `misc.chatspeak` | Avoiding lolling and other chatspeak |
| `misc.credit_card` | Keeping credit card numbers secret |
| `misc.commercialese` | Avoiding jargon of the commercial world |
| `misc.currency` | Avoiding redundant currency symbols |
| `misc.hyperbolic` | Not being hyperbolic |
| `misc.link_checker` | Linking only to existing sites |
| `misc.password` | Keeping passwords secret |
| `misc.whence` | Usage of the word "whence" |
| `nfl.naughty_words` | Avoiding words banned by the NFL |
| `nordquist.redundancy` | Avoiding redundancy and saying things twice |
| `norris.denizen_labels` | Using the right denizen label |
| `ogilvy.pretension` | Avoiding being pretentious |
| `orwell.debased` | Avoiding debased language |
| `oxford.venery_terms` | Call groups of animals by the right name |
| `palahniuk.suddenly` | Avoiding the word suddenly |
| `pinker.apologizing` | Being confident |
| `pinker.hedging` | Not hedging |
| `pinker.latin` | Avoiding overuse of Latin phrases |
| `pinker.metaconcepts` | Avoiding overuse of metaconcepts |
| `pinker.narcisissm` | Talking about the subject, not its study |
| `pinker.scare_quotes` | Using scare quotes only when needed |
| `strunk_white.composition` | Avoiding wordy phrases |
| `strunk_white.greylist` | Words to avoid |
| `strunk_white.usage` | Misc. usage recommendations |
| `typography.symbols` | Using the right symbol |
| `twain.damn` | Avoiding the word "very" |
| `wallace.tense_present` | Misc. advice |
| `wallace.uncomparables` | Not comparing uncomparables |
| `write_good.lexical_illusions` | Avoiding lexical illusions |
| `write_good.weasel_words` | Avoiding weasel words |
| `wsj.athletes` | Spelling the names of athletes correctly |
| `misc.debased` | Avoiding debased language |
| `misc.false_plurals` | Avoiding false plurals |
| `misc.illogic` | Avoiding illogical forms |
| `misc.inferior_superior` | Superior to, not than |
| `misc.latin` | Avoiding overuse of Latin phrases |
| `misc.many_a` | Many a singular |
| `misc.metaconcepts` | Avoiding overuse of metaconcepts |
| `misc.narcisissm` | Talking about the subject, not its study |
| `misc.phrasal_adjectives` | Hyphenating phrasal adjectives |
| `misc.preferred_forms` | Miscellaneous preferred forms |
| `misc.pretension` | Avoiding being pretentious |
| `misc.professions` | Calling jobs by the right name |
| `misc.punctuation` | Using punctuation assiduously |
| `misc.scare_quotes` | Using scare quotes only when needed |
| `misc.suddenly` | Avoiding the word suddenly |
| `misc.tense_present` | Advice from Tense Present |
| `misc.waxed` | Waxing poetic |
| `misc.whence` | Using "whence" |
| `mixed_metaphors.misc` | Not mixing metaphors |
| `mondegreens.misc` | Avoiding mondegreen |
| `needless_variants.misc` | Using the preferred form |
| `nonwords.misc` | Avoid using nonwords |
| `oxymorons.misc` | Avoiding oxymorons |
| `psychology.misc` | Avoiding misused psychological terms |
| `redundancy.misc` | Avoiding redundancy and saying things twice |
| `redundancy.ras_syndrome` | Avoiding RAS syndrome |
| `skunked_terms.misc` | Avoid using skunked terms |
| `spelling.able_atable` | -able vs. -atable |
| `spelling.able_ible` | -able vs. -ible |
| `spelling.athletes` | Spelling of athlete names |
| `spelling.em_im_en_in` | -em vs. -im and -en vs. -in |
| `spelling.er_or` | -er vs. -or |
| `spelling.in_un` | in- vs. un- |
| `spelling.misc` | Spelling words corectly |
| `security.credit_card` | Keeping credit card numbers secret |
| `security.password` | Keeping passwords secret |
| `sexism.misc` | Avoiding sexist language |
| `terms.animal_adjectives` | Animal adjectives |
| `terms.denizen_labels` | Calling denizens by the right name |
| `terms.eponymous_adjectives` | Calling people by the right name |
| `terms.venery` | Call groups of animals by the right name |
| `typography.diacritical_marks` | Using dïacríticâl marks |
| `typography.exclamation` | Avoiding overuse of exclamation |
| `typography.symbols` | Using the right symbols |
| `uncomparables.misc` | Not comparing uncomparables |
| `weasel_words.misc` | Avoiding weasel words |
| `weasel_words.very` | Avoiding the word "very" |

### Contributing

Expand Down
130 changes: 70 additions & 60 deletions site/_posts/2014-06-10-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,69 +10,79 @@ Here is a list of what <tt>proselint</tt> checks.

| ID | Description |
| ----- | --------------- |
| `carlin.filth` | Words to avoid |
| `annotations.misc` | Catching annotations left in the text |
| `cliches.hell` | Avoiding a common cliché |
| `cliches.misc` | Avoiding clichés |
| `consistency.spacing` | Consistent sentence spacing |
| `consistency.spelling` | Consistent use of British vs. American spelling |
| `garner.airlinese` | Avoiding jargon of the airline industry |
| `garner.am_pm` | Using the right form for the time of day |
| `garner.animal_labels` | Likening things to animals using fun words |
| `garner.archaism` | Avoiding archaic forms |
| `garner.back_formations` | Avoiding needless backformations |
| `garner.capitalization` | Captializing what ought to be capitalized |
| `cliches` | Avoiding cliché |
| `garner.commercialese` | Avoiding jargon of the commercial world |
| `garner.dates` | Stylish formatting of dates |
| `garner.denizen_labels` | Calling people the right names |
| `garner.diacritical_marks` | Using dïacríticâl marks |
| `garner.illogic` | Avoiding illogical forms |
| `garner.jargon` | Avoiding miscellaneous jargon |
| `garner.malapropisms` | Avoiding common malapropisms |
| `garner.many_a` | Many a singular |
| `garner.misspelling` | Avoiding common misspellings missed by spell-check |
| `garner.mixed_metaphors` | Not mixing metaphors |
| `garner.mondegreens` | Avoiding mondegreens |
| `garner.needless_variants` | Using the preferred form |
| `garner.oxymorons` | Avoiding oxymorons |
| `garner.preferred_forms` | Miscellaneous preferred forms |
| `garner.punctuation` | Using the right punctuation |
| `garner.redundancy` | Avoiding redundancy |
| `garner.sexism` | Avoiding sexist language |
| `gowers.overworked_metaphors` | Overworked metaphors |
| `inc.corporate_speak` | Avoiding corporate buzzwords |
| `leonard.exclamation` | Avoiding hyperbolic use of exclamation |
| `leonard.hell` | Avoiding a common cliché |
| `lilienfeld.terms_to_avoid` | Avoiding misused psychological terms |
| `misc.annotations` | Catching annotations left in the text |
| `consistency.spelling` | Consistent spelling |
| `corporate_speak.misc` | Avoiding corporate buzzwords` |
| `cursing.filth` | Words to avoid |
| `cursing.nfl` | Avoiding words banned by the NFL |
| `dates_times.am_pm` | Using the right form for the time of day |
| `dates_times.dates` | Stylish formatting of dates |
| `hedging.misc` | Not hedging |
| `hyperbole.misc` | Not being hyperbolic |
| `jargon.misc` | Avoiding miscellaneous jargon |
| `lexical_illusions.misc` | Avoiding lexical illusions |
| `links.broken` | Linking only to existing sites |
| `malapropisms.misc` | Avoiding common malapropisms |
| `misc.airlinese` | Avoiding jargon of the airline industry |
| `misc.apologizing` | Being confident |
| `misc.archaism` | Avoiding archaic forms |
| `misc.back_formations` | Avoiding needless backformations |
| `misc.bureaucratese` | Avoiding bureaucratese |
| `misc.but` | Avoid starting a paragraph with "But..." |
| `misc.capitalization` | Capitalizing only what ought to be capitalized |
| `misc.chatspeak` | Avoiding lolling and other chatspeak |
| `misc.credit_card` | Keeping credit card numbers secret |
| `misc.commercialese` | Avoiding jargon of the commercial world |
| `misc.currency` | Avoiding redundant currency symbols |
| `misc.hyperbolic` | Not being hyperbolic |
| `misc.link_checker` | Linking only to existing sites |
| `misc.password` | Keeping passwords secret |
| `misc.whence` | Usage of the word "whence" |
| `nfl.naughty_words` | Avoiding words banned by the NFL |
| `nordquist.redundancy` | Avoiding redundancy and saying things twice |
| `norris.denizen_labels` | Using the right denizen label |
| `ogilvy.pretension` | Avoiding being pretentious |
| `orwell.debased` | Avoiding debased language |
| `oxford.venery_terms` | Call groups of animals by the right name |
| `palahniuk.suddenly` | Avoiding the word suddenly |
| `pinker.apologizing` | Being confident |
| `pinker.hedging` | Not hedging |
| `pinker.latin` | Avoiding overuse of Latin phrases |
| `pinker.metaconcepts` | Avoiding overuse of metaconcepts |
| `pinker.narcisissm` | Talking about the subject, not its study |
| `pinker.scare_quotes` | Using scare quotes only when needed |
| `strunk_white.composition` | Avoiding wordy phrases |
| `strunk_white.greylist` | Words to avoid |
| `strunk_white.usage` | Misc. usage recommendations |
| `typography.symbols` | Using the right symbol |
| `wallace.tense_present` | Misc. advice |
| `wallace.uncomparables` | Not comparing uncomparables |
| `white.damn` | Avoiding the word "very" |
| `write_good.lexical_illusions` | Avoiding lexical illusions |
| `write_good.weasel_words` | Avoiding weasel words |
| `wsj.athletes` | Spelling the names of athletes correctly |
| `misc.debased` | Avoiding debased language |
| `misc.false_plurals` | Avoiding false plurals |
| `misc.illogic` | Avoiding illogical forms |
| `misc.inferior_superior` | Superior to, not than |
| `misc.latin` | Avoiding overuse of Latin phrases |
| `misc.many_a` | Many a singular |
| `misc.metaconcepts` | Avoiding overuse of metaconcepts |
| `misc.narcisissm` | Talking about the subject, not its study |
| `misc.phrasal_adjectives` | Hyphenating phrasal adjectives |
| `misc.preferred_forms` | Miscellaneous preferred forms |
| `misc.pretension` | Avoiding being pretentious |
| `misc.professions` | Calling jobs by the right name |
| `misc.punctuation` | Using punctuation assiduously |
| `misc.scare_quotes` | Using scare quotes only when needed |
| `misc.suddenly` | Avoiding the word suddenly |
| `misc.tense_present` | Advice from Tense Present |
| `misc.waxed` | Waxing poetic |
| `misc.whence` | Using "whence" |
| `mixed_metaphors.misc` | Not mixing metaphors |
| `mondegreens.misc` | Avoiding mondegreen |
| `needless_variants.misc` | Using the preferred form |
| `nonwords.misc` | Avoid using nonwords |
| `oxymorons.misc` | Avoiding oxymorons |
| `psychology.misc` | Avoiding misused psychological terms |
| `redundancy.misc` | Avoiding redundancy and saying things twice |
| `redundancy.ras_syndrome` | Avoiding RAS syndrome |
| `skunked_terms.misc` | Avoid using skunked terms |
| `spelling.able_atable` | -able vs. -atable |
| `spelling.able_ible` | -able vs. -ible |
| `spelling.athletes` | Spelling of athlete names |
| `spelling.em_im_en_in` | -em vs. -im and -en vs. -in |
| `spelling.er_or` | -er vs. -or |
| `spelling.in_un` | in- vs. un- |
| `spelling.misc` | Spelling words corectly |
| `security.credit_card` | Keeping credit card numbers secret |
| `security.password` | Keeping passwords secret |
| `sexism.misc` | Avoiding sexist language |
| `terms.animal_adjectives` | Animal adjectives |
| `terms.denizen_labels` | Calling denizens by the right name |
| `terms.eponymous_adjectives` | Calling people by the right name |
| `terms.venery` | Call groups of animals by the right name |
| `typography.diacritical_marks` | Using dïacríticâl marks |
| `typography.exclamation` | Avoiding overuse of exclamation |
| `typography.symbols` | Using the right symbols |
| `uncomparables.misc` | Not comparing uncomparables |
| `weasel_words.misc` | Avoiding weasel words |
| `weasel_words.very` | Avoiding the word "very" |


---
Expand Down

0 comments on commit 7eced8f

Please sign in to comment.