Skip to content

Commit

Permalink
Merge pull request #177 from amperser/typos
Browse files Browse the repository at this point in the history
Fix typos
  • Loading branch information
suchow committed Sep 28, 2015
2 parents bb91188 + 71e3ca9 commit d2f218e
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ You can disable any of the checks by modifying `.proselintrc`.
| `garner.denizen_labels` | Calling people the right names |
| `garner.illogic` | Avoiding illogical forms |
| `garner.jargon` | Avoiding miscellaneous jargon |
| `garner.malaproprisms` | Avoiding common malaproprisms |
| `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 |
Expand Down
2 changes: 1 addition & 1 deletion admin/communication/sources/garner.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ I'm Jordan Suchow, a cognitive scientist at UC Berkeley and a fan of your work

Proselint scans prose for errors in usage and style. Our larger goal is to aggregate knowledge about best practices in writing and to make that knowledge immediately accessible to all authors in the form of a linter for prose. (The term "linter" is borrowed from computer science, where it describes a computer program that scans source code for syntactic and stylistic errors.)

In the process of building Proselint, I implemented several hundred entries from your usage dictionary. Proselint will notice, for example, when you compare an uncomparable adjective, employ the wrong denizen label, use gender-biased language, or use a needless variant of a word. We've also implemented advice from other sources – Steve Pinker, Mary Norris, Philip Corbett, Chuck Palahniuk, among others. Unlike existing tools, which typically focus on school-book grammar and have false-alarm rates so high that their advice can not be trusted, we started where you did: with redundancy, jargon, illogic, clichés, sexism, misspelling, inconsistency, symbol misuse, malaproprisms, oxymorons, hedging, apologizing, pretension, and more. This has made it possible to create a tool that is fast and precise. Better to be quiet and authoritative than loud and unreliable. We habitually test our tool against writing from well-edited books and literary magazines, where it is mostly silent, but sometimes has useful things to say.
In the process of building Proselint, I implemented several hundred entries from your usage dictionary. Proselint will notice, for example, when you compare an uncomparable adjective, employ the wrong denizen label, use gender-biased language, or use a needless variant of a word. We've also implemented advice from other sources – Steve Pinker, Mary Norris, Philip Corbett, Chuck Palahniuk, among others. Unlike existing tools, which typically focus on school-book grammar and have false-alarm rates so high that their advice can not be trusted, we started where you did: with redundancy, jargon, illogic, clichés, sexism, misspelling, inconsistency, symbol misuse, malapropisms, oxymorons, hedging, apologizing, pretension, and more. This has made it possible to create a tool that is fast and precise. Better to be quiet and authoritative than loud and unreliable. We habitually test our tool against writing from well-edited books and literary magazines, where it is mostly silent, but sometimes has useful things to say.

We'd like your permission to use your advice in our tool. Can we? This would be less an endorsement than permission to attribute your ideas to you. Consider, for example, when we catch someone writing "Hong Kongian". We want to tell them that the preferred form is "Hong Konger", that you are the source of this advice, and that they can find more information by following a provided citation/link to the corresponding entry in your usage guide.

Expand Down
2 changes: 1 addition & 1 deletion proselint/.proselintrc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"garner.denizen_labels" : true,
"garner.illogic" : true,
"garner.jargon" : true,
"garner.malaproprisms" : true,
"garner.malapropisms" : true,
"garner.many_a" : true,
"garner.misspelling" : true,
"garner.mixed_metaphors" : true,
Expand Down
4 changes: 2 additions & 2 deletions proselint/checks/garner/malaproprisms.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
@memoize
def check(text):
"""Check the text."""
err = "garner.malaproprisms"
msg = u"'{}' is a malaproprism."
err = "garner.malapropisms"
msg = u"'{}' is a malapropism."

illogics = [
"the infinitesimal universe",
Expand Down
2 changes: 1 addition & 1 deletion site/_posts/2014-06-10-approach.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ categories: proselint api
<p>Is <tt>proselint</tt> yet another awful grammar checker?</p>
<p><em>No</em>. Here&rsquo;s why not:</p>
<ol>
<li><tt>proselint</tt> does not focus on grammar, which is at once too easy and too hard --- too easy because, for most native speakers, it comes naturally; too hard because, in its most general form, detecting grammatical errors is AI-complete, requiring human-level intelligence to get things right. Instead, we consider usage: redundancy, jargon, illogic, clichés, sexism, misspelling, inconsistency, misuse of symbols, malaproprisms, oxymorons, security gaffes, hedging, apologizing, pretension, and more.</li>
<li><tt>proselint</tt> does not focus on grammar, which is at once too easy and too hard &mdash; too easy because, for most native speakers, it comes naturally; too hard because, in its most general form, detecting grammatical errors is AI-complete, requiring human-level intelligence to get things right. Instead, we consider usage: redundancy, jargon, illogic, clichés, sexism, misspelling, inconsistency, misuse of symbols, malapropisms, oxymorons, security gaffes, hedging, apologizing, pretension, and more.</li>
<li><tt>proselint</tt> is precise. Existing tools for improving prose raise so many false alarms that their advice can not be trusted. Instead, the writer must carefully consider whether to accept or reject each change. We aim for a tool so precise that it becomes possible to unquestioningly adopt its recommendations and still come out ahead &mdash; with stronger, tighter prose. We track our false alarm rate and keep it low. Better to be quiet and authoritative than loud and unreliable.</li>
<li><tt>proselint</tt> defers to the world&rsquo;s greatest writers and editors. We didn&rsquo;t make up this advice on our own. Instead, we aggregated their expertise, giving you direct access to humanity&rsquo;s collective understanding about the craft of writing.</li>
</ol>
Expand Down
2 changes: 1 addition & 1 deletion site/_posts/2014-06-10-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Here is a list of what <tt>proselint</tt> checks.
| `garner.denizen_labels` | Calling people the right names |
| `garner.illogic` | Avoiding illogical forms |
| `garner.jargon` | Avoiding miscellaneous jargon |
| `garner.malaproprisms` | Avoiding common malaproprisms |
| `garner.malapropisms` | Avoiding common malapropisms |
| `garner.many_a` | Many a singular |
| `garner.misspelling` | Avoiding common misspellings missed by spellcheck |
| `garner.mixed_metaphors` | Not mixing metaphors |
Expand Down

0 comments on commit d2f218e

Please sign in to comment.