From 87772c28847a7c9ed0843a32eb25dbec7a60b5f5 Mon Sep 17 00:00:00 2001 From: Farookh Zaheer Siddiqui <129654632+FarukhS52@users.noreply.github.com> Date: Sat, 28 Oct 2023 23:06:39 +0530 Subject: [PATCH] Fix typo (#8309) ## Summary ## Test Plan --- CONTRIBUTING.md | 4 ++-- docs/preview.md | 2 +- docs/tutorial.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35562266b9..0f6f6ea1cf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -114,7 +114,7 @@ such that all crates are contained in a flat `crates` directory. The vast majority of the code, including all lint rules, lives in the `ruff` crate (located at `crates/ruff_linter`). As a contributor, that's the crate that'll be most relevant to you. -At time of writing, the repository includes the following crates: +At the time of writing, the repository includes the following crates: - `crates/ruff_linter`: library crate containing all lint rules and the core logic for running them. If you're working on a rule, this is the crate for you. @@ -877,5 +877,5 @@ By default, `src` is set to the project root. In the above example, we'd want to `src = ["./src"]` to ensure that we locate `./my_project/src/foo` and thus categorize `import foo` as first-party in `baz.py`. In practice, for this limited example, setting `src = ["./src"]` is unnecessary, as all imports within `./my_project/src/foo` would be categorized as first-party via -the same-package heuristic; but your project contains multiple packages, you'll want to set `src` +the same-package heuristic; but if your project contains multiple packages, you'll want to set `src` explicitly. diff --git a/docs/preview.md b/docs/preview.md index 0c369d4245..ccb04bb024 100644 --- a/docs/preview.md +++ b/docs/preview.md @@ -50,7 +50,7 @@ Similarly, it would _not_ be enabled via the `ALL` selector: select = ["ALL"] ``` -However, it would be enabled in any of the above cases if you you enabled preview in your configuration file: +However, it would be enabled in any of the above cases if you enabled preview in your configuration file: ```toml [tool.ruff] diff --git a/docs/tutorial.md b/docs/tutorial.md index 25b2a7023e..54eff737dc 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -251,7 +251,7 @@ For more in-depth instructions on ignoring errors, please see [_Error suppressio When enabling a new rule on an existing codebase, you may want to ignore all _existing_ violations of that rule and instead focus on enforcing it going forward. -Ruff enables this workflow via the `--add-noqa` flag, which will adds a `# noqa` directive to each +Ruff enables this workflow via the `--add-noqa` flag, which will add a `# noqa` directive to each line based on its existing violations. We can combine `--add-noqa` with the `--select` command-line flag to add `# noqa` directives to all existing `UP035` violations: