Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Great writing should come back nearly clean #25

Closed
suchow opened this issue Jan 22, 2015 · 4 comments
Closed

Great writing should come back nearly clean #25

suchow opened this issue Jan 22, 2015 · 4 comments

Comments

@suchow
Copy link
Member

suchow commented Jan 22, 2015

It would be good to include an automated test sweet that runs the linter over writing that is written by a great author and has already been heavily edited and copyedited (e.g., an essay from The New Yorker that went on to win the Pulitzer prize in nonfiction) . The linter should be nearly silent.

@suchow
Copy link
Member Author

suchow commented Jan 22, 2015

I mention this because the defaults of tools like write-good are extremely noisy, false alarming on many words and phrases (e.g., banning the word "only", which is sometimes used improperly, but is often part of a sentence's essential logical structure).

@suchow
Copy link
Member Author

suchow commented Jan 23, 2015

The idea is really just that you shouldn't introduce a new rule that alone finds tens or hundreds of errors in top-notch writing. That would be surprising and would suggest that your rule was too noisy. We'll have to figure out the right metric to use here --- how we tell if a rule is too noisy. Maybe we can create a metric like words per error (wpe) and set a threshold for top-notch text and normal text.

@suchow suchow closed this as completed Jan 27, 2015
@mpacer
Copy link
Member

mpacer commented Jan 27, 2015

why did you close this I think its a good point?

On Tuesday, January 27, 2015, Jordan Suchow notifications@github.com
wrote:

Closed #25 #25.


Reply to this email directly or view it on GitHub
#25 (comment).

@suchow
Copy link
Member Author

suchow commented Jan 27, 2015

It's fixed! The test suite runs the linter on all the samples in tests/samples, and if any of the checks gives a ton of errors for any of the samples, the test fails.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants