mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-01 14:21:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Fix misspelled TOML headers in the tutorial (#8209)

Browse source 
## Summary

Fixes misspelled TOML headers in the tutorial regarding the
configuration of the Ruff Linter.
This commit is contained in:
Otso Velhonoja 2023-10-25 13:52:42 +03:00 • committed by GitHub
parent fd07a12a52
commit f55b724254
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/tutorial.md
View file

@ -110,7 +110,7 @@ To configure Ruff, let's create a `pyproject.toml` file in our project's root di
# Set the maximum line length to 79. # Set the maximum line length to 79.
line-length = 79 line-length = 79
[tool.ruff.linter] [tool.ruff.lint]
# Add the `line-too-long` rule to the enforced rule set. By default, Ruff omits rules that # Add the `line-too-long` rule to the enforced rule set. By default, Ruff omits rules that
# overlap with the use of a formatter, like Black, but we can override this behavior by # overlap with the use of a formatter, like Black, but we can override this behavior by
# explicitly adding the rule. # explicitly adding the rule.
@ -137,7 +137,7 @@ requires-python = ">=3.10"
# Set the maximum line length to 79. # Set the maximum line length to 79.
line-length = 79 line-length = 79
[tool.ruff.linter] [tool.ruff.lint]
# Add the `line-too-long` rule to the enforced rule set. # Add the `line-too-long` rule to the enforced rule set.
extend-select = ["E501"] extend-select = ["E501"]
``` ```
@ -164,7 +164,7 @@ rules, we can set our `pyproject.toml` to the following:
[project] [project]
requires-python = ">=3.10" requires-python = ">=3.10"
[tool.ruff.linter] [tool.ruff.lint]
extend-select = [ extend-select = [
"UP", # pyupgrade "UP", # pyupgrade
] ]
@ -187,13 +187,13 @@ all functions have docstrings:
[project] [project]
requires-python = ">=3.10" requires-python = ">=3.10"
[tool.ruff.linter] [tool.ruff.lint]
extend-select = [ extend-select = [
"UP", # pyupgrade "UP", # pyupgrade
"D", # pydocstyle "D", # pydocstyle
] ]
[tool.ruff.linter.pydocstyle] [tool.ruff.lint.pydocstyle]
convention = "google" convention = "google"
``` ```