Update README.md #5277
Update README.md #5277
Conversation
- don't use conjunctions - don't use double-negatives - clarify what TSLint is
|
Thanks for the PR, @Zamiell! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| @@ -7,7 +7,7 @@ sidebar_label: Linting your TypeScript Codebase | |||
| import Tabs from '@theme/Tabs'; | |||
| import TabItem from '@theme/TabItem'; | |||
|
|
|||
| Whether you're adding linting to a new TypeScript codebase, adding TypeScript to an old codebase, or migrating from the deprecated [TSLint](https://www.npmjs.com/package/tslint), the steps aren't a whole lot different. | |||
| Whether you are adding linting to a new TypeScript codebase, adding TypeScript to an old codebase, or migrating from the deprecated [TSLint](https://www.npmjs.com/package/tslint) tool, the steps to follow are similar. | |||
There was a problem hiding this comment.
I disagree with removing the conjunction. The 're shortens the phrasing and makes the sentence sound less robotic.
There was a problem hiding this comment.
In my experience, use of contractions in technical writing is minimized. The benefits of conveying a friendly tone have to be weighed against making the text marginally harder for foreign-language speakers to understand. Here, we expect that people throughout the world will be using the TypeScript programming language, so the documentation should reflect that.
There was a problem hiding this comment.
"'re" won't be confused with anything; the TS-ESLint docs aren't formal writing either. I do prefer no-contractions myself, but I can't find a reason strong enough to warrant a change, particularly if it sets a precedent.
|
Pardon my closing the PR - since #5248 is in, this PR is against deleted code. Thanks though! ❤️ |
#5247