typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star15.7k

Update README.md#5277

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

Zamiell wants to merge2 commits intotypescript-eslint:mainfromZamiell:patch-1

Closed

Update README.md#5277

Zamiell wants to merge2 commits intotypescript-eslint:mainfromZamiell:patch-1

Conversation

Copy link

Contributor

Zamiell commentedJun 30, 2022•
edited
Loading

don't use conjunctions
don't use double-negatives
clarify what TSLint is

#5247

Update README.md

0ba6829

- don't use conjunctions- don't use double-negatives- clarify what TSLint is

Copy link

nx-cloudbot commentedJun 30, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit8f96c18. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 fromNxCloud.

Copy link

Contributor

typescript-eslintbot commentedJun 30, 2022

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 visitorsper day.

Copy link

netlifybot commentedJun 30, 2022•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`8f96c18`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/62be41e74de1d500087196f6
😎 Deploy Preview	https://deploy-preview-5277--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to yourNetlify site settings.

JoshuaKGoldberg requested changes

Jun 30, 2022

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks for sending this! The latter two changes I agree with and find pleasing. 😄

docs/linting/README.md

		@@ -7,7 +7,7 @@ sidebar_label: Linting your TypeScript Codebase
		import Tabs from '@theme/Tabs';
		import TabItem from '@theme/TabItem';

		Whether you'readding 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 stepsaren't a whole lot different.
		Whether you areadding 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 stepsto follow are similar.

Copy link

Member

JoshuaKGoldbergJun 30, 2022•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I disagree with removing the conjunction. The're shortens the phrasing and makes the sentence sound less robotic.

Copy link

ContributorAuthor

ZamiellJul 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

Copy link

ContributorAuthor

ZamiellJul 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Copy link

Member

Josh-CenaJul 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

"'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.