Commit graph

12 commits

Author SHA1 Message Date
F-G Fernandez
2effdb8ebd
Fix href to rules md file in the configuration description (#381)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
2025-05-14 11:10:21 +00:00
Micha Reiser
12f466e461
Bump version to 0.0.1a1 (#356)
Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Co-authored-by: David Peter <mail@david-peter.de>
2025-05-13 21:10:00 +05:30
Dhruv Manilawala
6303305e17
Add reference for editor settings (#343)
Co-authored-by: Micha Reiser <micha@reiser.io>
2025-05-13 11:19:13 +02:00
David Peter
a188aeb7b5
Minor clarifications in Python version docs (#344)
## Summary

This is unfortunately longer than what we had, but I thought that this
section could use some clarification. In particular, newer syntactic
features can not appear in `sys.version_info` branches, they will always
lead to errors.
2025-05-13 09:33:35 +02:00
David Peter
8c5053f51e
Rule levels: minor wording suggestion (#345)
## Summary

"Enable `unused-ignore-comment` at warn" sounded strange to me, so I'm
suggesting a minor rewording.
2025-05-13 09:33:26 +02:00
Dhruv Manilawala
0c3a81dd56
Fix link to configuration reference page (#342) 2025-05-13 08:37:26 +05:30
Carl Meyer
48201113d2
fix link to CLI docs (#341)
## Summary

The file is `cli.md`, not `commands.md`.

Not sure if there was an incomplete intention to rename the file here,
but for the moment I'm just fixing the link; renaming the file will
require adjusting at least the release script and possibly changing it
in the ruff repo as well.

## Test Plan

On this branch, the link works.
2025-05-12 20:01:09 -07:00
Zanie Blue
5ee27474dc
Edit the rule level and suppression comment sections (#337) 2025-05-12 23:47:31 +00:00
Zanie Blue
73631eebb4
Edit the module and editor sections of the docs (#335)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-05-12 17:38:14 -05:00
Zanie Blue
994caa6fcc
Rewrite the getting started documentation (#329)
[Rendered](https://github.com/astral-sh/ty/tree/zb/getting-started?tab=readme-ov-file#getting-started)
2025-05-12 14:59:43 -05:00
Zanie Blue
5f9803b4fa
Split the documentation out of the top-level README (#331)
Moves most of the documentation into a dedicated `docs/README` to make
it easier to reach important content in the top-level readme like
"getting involved".

There are some minor changes to the heading levels here and link
changes, but otherwise the content is the same. Don't go deep on the
getting started section, that's changing in #329
2025-05-12 13:45:02 -05:00
Micha Reiser
b3073684d0
Reference documentation (#292) 2025-05-10 10:26:31 +00:00