Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Term "linter" not understood #66

Closed
camerons opened this issue Dec 1, 2019 · 4 comments
Closed

Term "linter" not understood #66

camerons opened this issue Dec 1, 2019 · 4 comments
Labels
improve For any suggestions about how to make templates better. writing-tips

Comments

@camerons
Copy link
Member

camerons commented Dec 1, 2019

Document: https://github.com/thegooddocsproject/templates/blob/master/writing-tips.md

Re:

Run your text through a grammar linter to check how readable it is.
Tools like Grammarly help you identify grammar issues
Tools like Vale help you identify style issues.

Felicity Brand
13:34 14 Nov
First time I've ever come across this word. Might not translate well?

Josh Sherwood
13:36 14 Nov
Agreed ++

Louise Brooks
13:41 14 Nov
linter? what's that?!

Josh Sherwood
13:30 14 Nov
Include links to these tools?

@camerons camerons added improve For any suggestions about how to make templates better. writing-tips labels Dec 1, 2019
@bjnath
Copy link

bjnath commented Apr 20, 2020

First time I've ever come across this word. Might not translate well?

Perhaps we can link the word to its Wikipedia article. That not only will gloss it, it will make the definition available in multiple languages.

I'd hesitate to drop it, because it connects with developer experience and the metaphor is witty. (And, unlike humor generally, it'll stay witty to those who need to look it up.)

@jaredmorgs
Copy link
Contributor

I agree this is the correct approach. Particularly as we list two grammar linters directly below the offending line.

emckean added a commit that referenced this issue Apr 25, 2020
adding link to Wikipedia and link to article discussing other grammar linter tools
camerons added a commit that referenced this issue May 12, 2020
@shreyas1599
Copy link
Contributor

shreyas1599 commented May 14, 2020

@camerons @jaredmorgs I think this issue can be closed. Looks like #109 fixed it.

@jaredmorgs
Copy link
Contributor

Closing

camerons pushed a commit to camerons/templates that referenced this issue Feb 27, 2021
adding link to Wikipedia and link to article discussing other grammar linter tools
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
improve For any suggestions about how to make templates better. writing-tips
Projects
None yet
Development

No branches or pull requests

4 participants