Commit graph

30 commits

Author SHA1 Message Date
Dhruv Manilawala
07868315cb
Add ty.inlayHints.callArgumentNames reference (#981) 2025-08-14 15:04:13 +05:30
Dhruv Manilawala
daf8e91b93
Add ty.experimental.rename, ty.inlayHints.variableTypes (#951)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
CI / mkdocs (push) Has been cancelled
## Summary

This PR adds reference documentation for the two new editor settings
that were added in https://github.com/astral-sh/ruff/pull/19800 and
https://github.com/astral-sh/ruff/pull/19780.

## Test Plan

<img width="2491" height="1374" alt="Screenshot 2025-08-07 at 19 24 44"
src="https://github.com/user-attachments/assets/f0fc32c5-1045-4fd9-900d-c4e7e429d54f"
/>
2025-08-07 19:37:44 +05:30
Dhruv Manilawala
7858ecb61b
Update editor settings reference with new format (#944)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
## Summary

This PR updates the documentation to reflect the changes made in
https://github.com/astral-sh/ruff/pull/19614 and
https://github.com/astral-sh/ty-vscode/pull/106.

## Test Plan

<details><summary>Screenshot of the new editor settings reference
page:</summary>
<p>

<img width="4992" height="3702" alt="image"
src="https://github.com/user-attachments/assets/e3afd5a3-8b5b-43c3-addd-e1d6636ab1b7"
/>

</p>
</details>
2025-08-07 10:31:22 +05:30
Dhruv Manilawala
1712284c8f
Bump version to 0.0.1-alpha.17 (#945)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
2025-08-06 17:30:28 +05:30
David Peter
c452e53a04
Bump version to 0.0.1-alpha.16 (#890)
Some checks failed
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
CI / python package (push) Has been cancelled
CI / mkdocs (push) Has been cancelled
Changes which I chose not to include; let me know if one of these should
be added:

```
- Add warning for unknown `TY_MEMORY_REPORT` value ([#19465](https://github.com/astral-sh/ruff/pull/19465))
- Add goto definition to playground ([#19425](https://github.com/astral-sh/ruff/pull/19425))
- Added support for "go to references" in ty playground. ([#19516](https://github.com/astral-sh/ruff/pull/19516))
- Fall back to `Unknown` if no type is stored for an expression ([#19517](https://github.com/astral-sh/ruff/pull/19517))
- Make `Module` a Salsa ingredient ([#19495](https://github.com/astral-sh/ruff/pull/19495))
- Return a tuple spec from the iterator protocol ([#19496](https://github.com/astral-sh/ruff/pull/19496))
```

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-07-25 15:46:28 +02:00
David Peter
0369a35981
Bump version to 0.0.1-alpha.15 (#852)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
CI / mkdocs (push) Has been cancelled
2025-07-18 14:49:13 +02:00
Charlie Marsh
232a5d6895
Sync env.md script in release pipeline (#782)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
CI / mkdocs (push) Has been cancelled
## Summary

See: https://github.com/astral-sh/ruff/pull/19205

Closes: https://github.com/astral-sh/ty/issues/773.
2025-07-08 11:34:51 -04:00
Alex Waygood
3ececb07e6
Bump version to 0.0.1-alpha.14 (#778)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
Co-authored-by: David Peter <sharkdp@users.noreply.github.com>
2025-07-08 12:46:08 +01:00
Dhruv Manilawala
21886e591c
Add docs for ty.diagnosticMode (#779) 2025-07-08 12:21:13 +01:00
हिमांशु
a38c3c30d9
Document TY_MEMORY_REPORT (#768)
Some checks are pending
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / python package (push) Waiting to run
## Summary

Closes #714.
2025-07-07 16:53:50 +00:00
David Peter
6a408d5f98
Bump version to 0.0.1a13 (#756)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
CI / mkdocs (push) Has been cancelled
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-07-02 19:39:04 +02:00
David Peter
c70ae8c84a Update ruff submodule reference and auto-generate files 2025-07-02 09:40:49 -05:00
David Peter
75af7fca4d Minor adjustments to docs (#752) 2025-07-02 09:40:49 -05:00
Zanie Blue
3634c41020 Naively split the "Overview" page into child pages (#748)
Splits each top-level heading of the existing documentation into
a dedicated page as a starting point.

---------

Co-authored-by: David Peter <mail@david-peter.de>
2025-07-02 09:40:49 -05:00
Zanie Blue
c14037ab2a Copy basic template and styling for documentation from uv (#729)
This copies the documentation scaffolding from uv, doing the minimum
amount of work to make it viable.

---------

Co-authored-by: David Peter <sharkdp@users.noreply.github.com>
2025-07-02 09:40:49 -05:00
Alex Waygood
f7446a6ee7
Bump version to 0.0.1-alpha.12 (#700)
Co-authored-by: David Peter <sharkdp@users.noreply.github.com>
2025-06-25 12:37:46 +01:00
Dhruv Manilawala
27e0a80f46
Document python.ty.disableLanguageServices (#668)
This PR documents the new option `python.ty.disableLanguageServices`.
2025-06-18 11:58:43 +05:30
David Peter
1ae7038368
Bump version to 0.0.1a11 (#672)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
Co-authored-by: Carl Meyer <carl@astral.sh>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-06-17 22:28:08 +02:00
Andrew Gallant
efa735beac
docs: remove experimental section (#650)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
This was only used to opt into completions. But we're removing the
opt-in in https://github.com/astral-sh/ruff/pull/18650, so let's remove
it from the docs too.

Ref #86
2025-06-16 07:43:25 -04:00
Carl Meyer
15bae14c22
Bump version to 0.0.1-alpha.10 (#651)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-06-13 20:19:49 +00:00
Dhruv Manilawala
2feba5eb22
Bump version to 0.0.1-alpha.9 (#634)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
2025-06-11 11:05:43 +00:00
Charlie Marsh
e69569b4fe
Update list of referenced environment variables (#612)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
Closes #564.
2025-06-08 20:10:20 -04:00
Dhruv Manilawala
c1337c962c
Bump version to 0.0.1-alpha.8 (#568)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-06-02 17:06:30 +05:30
David Peter
afb20f6feb
Bump version to 0.0.1a7 (#516)
Some checks failed
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-05-26 20:39:35 +02:00
Alex Waygood
f11c6012d7
Bump version to 0.0.1-alpha.6 (#465)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
2025-05-20 15:47:25 -04:00
David Peter
59c45cc60c
Bump version to 0.0.1a2 (#395) 2025-05-14 22:17:55 +02:00
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
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