Skip to content

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Update README.md #5277

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ba6829
Update README.md
Zamiell Jun 30, 2022
8f96c18
Merge branch 'main' into patch-1
Zamiell Jul 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/linting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg Jun 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
Contributor Author

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
Contributor Author

Choose a reason for hiding this comment

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

image

Copy link
Member

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.


## Installation

Expand Down