Micha Reiser
2587aef1ea
Add formatter to line-length documentation ( #8150 )
2023-10-24 07:55:20 +00:00
Charlie Marsh
f6d6200aae
Rework the documentation to incorporate the Ruff formatter ( #7732 )
...
## Summary
This PR updates our documentation for the upcoming formatter release.
Broadly, the documentation is now structured as follows:
- Overview
- Tutorial
- Installing Ruff
- The Ruff Linter
- Overview
- `ruff check`
- Rule selection
- Error suppression
- Exit codes
- The Ruff Formatter
- Overview
- `ruff format`
- Philosophy
- Configuration
- Format suppression
- Exit codes
- Black compatibility
- Known deviations
- Configuring Ruff
- pyproject.toml
- File discovery
- Configuration discovery
- CLI
- Shell autocompletion
- Preview
- Rules
- Settings
- Integrations
- `pre-commit`
- VS Code
- LSP
- PyCharm
- GitHub Actions
- FAQ
- Contributing
The major changes include:
- Removing the "Usage" section from the docs, and instead folding that
information into "Integrations" and the new Linter and Formatter
sections.
- Breaking up "Configuration" into "Configuring Ruff" (for generic
configuration), and new Linter- and Formatter-specific sections.
- Updating all example configurations to use `[tool.ruff.lint]` and
`[tool.ruff.format]`.
My suggestion is to pull and build the docs locally, and review by
reading them in the browser rather than trying to parse all the code
changes.
Closes https://github.com/astral-sh/ruff/issues/7235 .
Closes https://github.com/astral-sh/ruff/issues/7647 .
2023-10-20 23:08:26 +00:00
Zanie Blue
22cf451d51
Release 0.1.1 ( #8073 )
...
- Add changelog entry for 0.1.1
- Bump version to 0.1.1
- Require preview for fix added in #7967
- Allow duplicate headings in changelog (markdownlint setting)
2023-10-19 20:49:53 +00:00
Zanie Blue
a327b4da87
sequence -> iterable in tutorial ( #8067 )
...
Very minor follow to https://github.com/astral-sh/ruff/pull/8066/
2023-10-19 12:25:45 -05:00
Charlie Marsh
cdc5e2fb58
Update tutorial to match revised Ruff defaults ( #8066 )
...
## Summary
We don't enable E501 by default, but `line-length` is a useful example
for configuration, so we now set `--extend-select` in the tutorial with
a note to that effect.
I've also updated all the outputs to match the latest CLI behavior, and
changed the example from `List` to `Sequence` because `List` now spits
out two diagnostics (one for the import, one for the usage), which IMO
is confusing for beginners.
2023-10-19 12:26:59 -04:00
Zanie Blue
1fabaca5de
Bump version to 0.1.0 ( #7931 )
...
[Rendered
changelog](https://github.com/astral-sh/ruff/blob/release/010/CHANGELOG.md )
2023-10-16 13:06:48 -05:00
Charlie Marsh
c6d0bdd572
Bump Ruff version to v0.0.292 ( #7761 )
2023-10-02 12:14:47 -04:00
Charlie Marsh
8bfe9bda41
Bump version to v0.0.291 ( #7606 )
2023-09-22 13:25:37 -04:00
T-256
814403cdf7
Bump lint rules count to 700 ( #7585 )
2023-09-21 21:55:03 -04:00
Zanie Blue
0c030b5bf3
Bump version to 0.0.290 ( #7413 )
...
See also:
- https://github.com/astral-sh/astral-sh/pull/41
- https://github.com/astral-sh/ruff-pre-commit/pull/51
2023-09-15 13:51:46 -05:00
James Braza
36fa1fe359
Docs linking error tutorial with error suppression ( #7014 )
...
Documents takeaway from
https://github.com/astral-sh/ruff/discussions/7011#discussioncomment-6869239 .
2023-09-13 20:22:18 -04:00
Charlie Marsh
e7a2779402
Bump version to v0.0.289 ( #7308 )
2023-09-12 12:00:11 -04:00
Micha Reiser
7c9bbcf4e2
Bump version to 0.0.288 ( #7271 )
...
Co-authored-by: Zanie Blue <contact@zanie.dev>
2023-09-11 18:18:11 +02:00
Charlie Marsh
2f3a950f6f
Bump version to 0.0.287 ( #7038 )
2023-09-01 17:32:26 +01:00
Charlie Marsh
91880b8273
Bump version to 0.0.286 ( #6876 )
2023-08-25 14:59:26 -04:00
Zanie Blue
5892c691ea
Bump version to 0.0.285 ( #6660 )
...
Requires
- https://github.com/astral-sh/ruff/pull/6655
- https://github.com/astral-sh/ruff/pull/6657
2023-08-17 15:46:28 -05:00
Charlie Marsh
5f709cd3e0
Bump rule count to 600+ in the docs ( #6579 )
...
My informal count yielded 679 rules as of yesterday.
2023-08-15 00:11:32 +00:00
Zanie Blue
3ecd263b4d
Bump version to 0.0.284 ( #6453 )
...
## What's Changed
This release fixes a few bugs, notably the previous release announced a
breaking change where the default target
Python version changed from 3.10 to 3.8 but it was not applied. Thanks
to @rco-ableton for fixing this in
https://github.com/astral-sh/ruff/pull/6444
### Bug Fixes
* Do not trigger `S108` if path is inside `tempfile.*` call by
@dhruvmanila in https://github.com/astral-sh/ruff/pull/6416
* Do not allow on zero tab width by @tjkuson in
https://github.com/astral-sh/ruff/pull/6429
* Fix false-positive in submodule resolution by @charliermarsh in
https://github.com/astral-sh/ruff/pull/6435
## New Contributors
* @rco-ableton made their first contribution in
https://github.com/astral-sh/ruff/pull/6444
**Full Changelog**:
https://github.com/astral-sh/ruff/compare/v0.0.283...v0.0.284
2023-08-09 13:32:33 -05:00
Zanie Blue
fe9590f39f
Bump version number to 0.0.283 ( #6407 )
2023-08-08 12:31:30 -05:00
Charlie Marsh
743118ae9a
Bump version to 0.0.282 ( #6241 )
2023-08-01 13:21:33 +00:00
Charlie Marsh
dbd60b2cf5
Bump version to 0.0.281 ( #6195 )
2023-07-31 13:21:43 -04:00
Charlie Marsh
f5a2fb5b5d
Bump version to 0.0.280 ( #5965 )
2023-07-21 22:36:13 -04:00
Charlie Marsh
f1f89f2a7e
Bump version to 0.0.279 ( #5949 )
2023-07-21 15:46:53 -04:00
Charlie Marsh
0ead9a16ac
Bump version to 0.0.278 ( #5714 )
2023-07-12 12:39:56 -04:00
Charlie Marsh
324455f580
Bump version to 0.0.277 ( #5515 )
2023-07-04 17:31:32 -04:00
Charlie Marsh
3992c47c00
Bump version to 0.0.276 ( #5488 )
2023-07-03 18:02:49 +00:00
Charlie Marsh
3238a6ef1f
Fix 'our' to 'your' typo ( #5303 )
2023-06-22 15:58:24 +00:00
Charlie Marsh
1c0a3a467f
Bump version to 0.0.275 ( #5276 )
2023-06-21 21:53:37 -04:00
Charlie Marsh
e0339b538b
Bump version to 0.0.274 ( #5230 )
2023-06-20 22:12:32 -04:00
Charlie Marsh
fde5dbc9aa
Bump version to 0.0.273 ( #5218 )
2023-06-20 14:37:28 -04:00
MT BENTERKI
c1fd2c8a8e
Update tutorial doc typo ( #5088 )
2023-06-14 11:17:35 -04:00
Charlie Marsh
5235977abc
Bump version to 0.0.272 ( #4948 )
2023-06-08 02:17:29 +00:00
Charlie Marsh
2b5fb70482
Bump version to 0.0.271 ( #4890 )
2023-06-06 15:11:48 -04:00
Charlie Marsh
f4572fe40b
Bump version to 0.0.270 ( #4637 )
2023-05-24 16:34:29 +00:00
Charlie Marsh
f22c269ccf
Point LSP, VS Code, and pre-commut URLs to Astral org ( #4562 )
2023-05-21 15:27:35 -04:00
Charlie Marsh
d4c0a41b00
Bump version to 0.0.269 ( #4506 )
2023-05-18 19:45:20 +00:00
Charlie Marsh
8702b5a40a
Bump version to 0.0.268 ( #4501 )
2023-05-18 15:35:46 -04:00
Charlie Marsh
dcedd5cd9d
Bump version to 0.0.267 ( #4400 )
2023-05-12 19:04:56 +00:00
Charlie Marsh
67076b2dcb
Bump version to 0.0.266 ( #4391 )
2023-05-12 13:11:03 -04:00
Charlie Marsh
11e1380df4
Bump version to 0.0.265 ( #4248 )
2023-05-05 13:16:05 -04:00
Charlie Marsh
8cb76f85eb
Bump version to 0.0.264 ( #4179 )
2023-05-01 23:33:38 -07:00
Charlie Marsh
fd7ccb4c9e
Bump version to 0.0.263 ( #4086 )
2023-04-24 23:32:29 -06:00
Pronoy Mandal
b7a57ce120
Update tutorial.md ( #4055 )
2023-04-21 10:56:31 -06:00
Charlie Marsh
25a6bfa9ee
Bump version to 0.0.262 ( #4032 )
2023-04-19 15:49:28 -04:00
Charlie Marsh
255b094b33
Bump version to 0.0.261 ( #3881 )
2023-04-04 22:31:01 -04:00
Charlie Marsh
9d3b8eb67b
Bump version to v0.0.260 ( #3799 )
2023-03-29 14:51:50 -04:00
Charlie Marsh
f58345dee3
Bump version to v0.0.259 ( #3691 )
2023-03-23 14:52:42 -04:00
Charlie Marsh
615887a7fe
Bump version to v0.0.258 ( #3671 )
2023-03-22 15:02:57 -04:00
Charlie Marsh
0c4926ff7b
Bump version to v0.0.257 ( #3591 )
2023-03-17 22:34:10 -04:00
Charlie Marsh
12dfd57211
Bump version to v0.0.256 ( #3531 )
2023-03-14 22:52:21 -04:00
