Skip to content

Commit 5e7ba05

Browse files
authored
docs(*): fix a few typos, consistency issues and links (#12193)
## Summary Fixes a few typos, consistency issues and dead links found across the documentation.
1 parent d12570e commit 5e7ba05

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ These represent, respectively: the schema used to parse the `pyproject.toml` fil
280280
intermediate representation; and the final, internal representation used to power Ruff.
281281
282282
To add a new configuration option, you'll likely want to modify these latter few files (along with
283-
`arg.rs`, if appropriate). If you want to pattern-match against an existing example, grep for
283+
`args.rs`, if appropriate). If you want to pattern-match against an existing example, grep for
284284
`dummy_variable_rgx`, which defines a regular expression to match against acceptable unused
285285
variables (e.g., `_`).
286286

docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ For a complete enumeration of the available configuration options, see [_Setting
254254

255255
## Config file discovery
256256

257-
Similar to [ESLint](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#cascading-and-hierarchy),
257+
Similar to [ESLint](https://eslint.org/docs/latest/use/configure/configuration-files#cascading-configuration-objects),
258258
Ruff supports hierarchical configuration, such that the "closest" config file in the
259259
directory hierarchy is used for every individual file, with all paths in the config file
260260
(e.g., `exclude` globs, `src` paths) being resolved relative to the directory containing that
@@ -275,7 +275,7 @@ There are a few exceptions to these rules:
275275
1. Any config-file-supported settings that are provided on the command-line (e.g., via
276276
`--select`) will override the settings in _every_ resolved configuration file.
277277

278-
Unlike [ESLint](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#cascading-and-hierarchy),
278+
Unlike [ESLint](https://eslint.org/docs/latest/use/configure/configuration-files#cascading-configuration-objects),
279279
Ruff does not merge settings across configuration files; instead, the "closest" configuration file
280280
is used, and any parent configuration files are ignored. In lieu of this implicit cascade, Ruff
281281
supports an [`extend`](settings.md#extend) field, which allows you to inherit the settings from another

docs/faq.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ natively, including:
6464
- [flake8-executable](https://pypi.org/project/flake8-executable/)
6565
- [flake8-gettext](https://pypi.org/project/flake8-gettext/)
6666
- [flake8-implicit-str-concat](https://pypi.org/project/flake8-implicit-str-concat/)
67-
- [flake8-import-conventions](https://github.com/joaopalmeiro/flake8-import-conventions)
67+
- [flake8-import-conventions](https://pypi.org/project/flake8-import-conventions/)
6868
- [flake8-logging](https://pypi.org/project/flake8-logging-format/)
6969
- [flake8-logging-format](https://pypi.org/project/flake8-logging-format/)
7070
- [flake8-no-pep420](https://pypi.org/project/flake8-no-pep420)
@@ -93,7 +93,7 @@ natively, including:
9393
- [pygrep-hooks](https://github.com/pre-commit/pygrep-hooks)
9494
- [pyupgrade](https://pypi.org/project/pyupgrade/)
9595
- [tryceratops](https://pypi.org/project/tryceratops/)
96-
- [yesqa](https://github.com/asottile/yesqa)
96+
- [yesqa](https://pypi.org/project/yesqa/)
9797

9898
Note that, in some cases, Ruff uses different rule codes and prefixes than would be found in the
9999
originating Flake8 plugins. For example, Ruff uses `TID252` to represent the `I252` rule from
@@ -177,7 +177,7 @@ Today, Ruff can be used to replace Flake8 when used with any of the following pl
177177
- [flake8-executable](https://pypi.org/project/flake8-executable/)
178178
- [flake8-gettext](https://pypi.org/project/flake8-gettext/)
179179
- [flake8-implicit-str-concat](https://pypi.org/project/flake8-implicit-str-concat/)
180-
- [flake8-import-conventions](https://github.com/joaopalmeiro/flake8-import-conventions)
180+
- [flake8-import-conventions](https://pypi.org/project/flake8-import-conventions/)
181181
- [flake8-logging](https://pypi.org/project/flake8-logging/)
182182
- [flake8-logging-format](https://pypi.org/project/flake8-logging-format/)
183183
- [flake8-no-pep420](https://pypi.org/project/flake8-no-pep420)
@@ -204,7 +204,7 @@ Today, Ruff can be used to replace Flake8 when used with any of the following pl
204204
- [tryceratops](https://pypi.org/project/tryceratops/)
205205

206206
Ruff can also replace [Black](https://pypi.org/project/black/), [isort](https://pypi.org/project/isort/),
207-
[yesqa](https://github.com/asottile/yesqa), [eradicate](https://pypi.org/project/eradicate/), and
207+
[yesqa](https://pypi.org/project/yesqa/), [eradicate](https://pypi.org/project/eradicate/), and
208208
most of the rules implemented in [pyupgrade](https://pypi.org/project/pyupgrade/).
209209

210210
If you're looking to use Ruff, but rely on an unsupported Flake8 plugin, feel free to file an
@@ -271,7 +271,7 @@ Like isort, Ruff's import sorting is compatible with Black.
271271

272272
## How does Ruff determine which of my imports are first-party, third-party, etc.?
273273

274-
Ruff accepts a `src` option that in your `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file, which
274+
Ruff accepts a `src` option that in your `pyproject.toml`, `ruff.toml`, or `.ruff.toml` file,
275275
specifies the directories that Ruff should consider when determining whether an import is
276276
first-party.
277277

@@ -602,7 +602,7 @@ convention = "google"
602602
```toml
603603
line-length = 88
604604

605-
[pydocstyle]
605+
[lint.pydocstyle]
606606
convention = "google"
607607
```
608608

@@ -619,9 +619,9 @@ and respects the `XDG_CONFIG_HOME` specification.
619619
On Windows, Ruff expects that file to be located at `~\AppData\Roaming\ruff\ruff.toml`.
620620

621621
!!! note
622-
Prior to `v0.5.0`, Ruff would read user-specific configuration from
623-
`~/Library/Application Support/ruff/ruff.toml` on macOS. While Ruff will still respect
624-
such configuration files, the use of `~/Library/ Application Support` is considered deprecated.
622+
Prior to `v0.5.0`, Ruff would read user-specific configuration from
623+
`~/Library/Application Support/ruff/ruff.toml` on macOS. While Ruff will still respect
624+
such configuration files, the use of `~/Library/Application Support` is considered deprecated.
625625

626626
For more, see the [`etcetera`](https://crates.io/crates/etcetera) crate.
627627

@@ -630,7 +630,7 @@ For more, see the [`etcetera`](https://crates.io/crates/etcetera) crate.
630630
Ruff labels fixes as "safe" and "unsafe". By default, Ruff will fix all violations for which safe
631631
fixes are available, while unsafe fixes can be enabled via the [`unsafe-fixes`](settings.md#unsafe-fixes)
632632
setting, or passing the [`--unsafe-fixes`](settings.md#unsafe-fixes) flag to `ruff check`. For
633-
more, see [the fix documentation](configuration.md#fixes).
633+
more, see [the fix documentation](linter.md#fixes).
634634

635635
Even still, given the dynamic nature of Python, it's difficult to have _complete_ certainty when
636636
making changes to code, even for seemingly trivial fixes. If a "safe" fix breaks your code, please

docs/integrations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Upon successful installation, you should see Ruff's diagnostics surfaced directl
9595

9696
![Code Actions available in Neovim](https://user-images.githubusercontent.com/1309177/208278707-25fa37e4-079d-4597-ad35-b95dba066960.png)
9797

98-
To use `ruff-lsp` with other editors, including Sublime Text and Helix, see the [`ruff-lsp` documentation](https://github.com/astral-sh/ruff-lsp#installation-and-usage).
98+
To use `ruff-lsp` with other editors, including Sublime Text and Helix, see the [`ruff-lsp` documentation](https://github.com/astral-sh/ruff-lsp#setup).
9999

100100
## Language Server Protocol (Unofficial)
101101

@@ -350,7 +350,7 @@ jobs:
350350
Ruff can also be used as a GitHub Action via [`ruff-action`](https://github.com/chartboost/ruff-action).
351351

352352
By default, `ruff-action` runs as a pass-fail test to ensure that a given repository doesn't contain
353-
any lint rule violations as per its [configuration](https://github.com/astral-sh/ruff/blob/main/docs/configuration.md).
353+
any lint rule violations as per its [configuration](configuration.md).
354354
However, under-the-hood, `ruff-action` installs and runs `ruff` directly, so it can be used to
355355
execute any supported `ruff` command (e.g., `ruff check --fix`).
356356

0 commit comments

Comments
 (0)