From ab3e82d389a6ab5478203932f4cd74ff16ff6c8f Mon Sep 17 00:00:00 2001 From: Rebecca Chen Date: Tue, 11 Jun 2024 20:32:50 -0400 Subject: [PATCH] Adds links to Python Discourse and ruff to typing.readthedocs.io (#1774) I noticed that the "Discussions and Support" section still linked to the typing-sig mailing list. While touching this page, I figured I might as well add ruff, which is used by typeshed, to the list of linters, and make the items in each list grammatically consistent. --- docs/index.rst | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 84f0a71ec..bad1f3dfa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,7 +54,8 @@ Discussions and Support * `User help forum `_ * `User chat on Gitter `_ -* `Developer mailing list `_ +* `Developer forum `_ +* `Developer mailing list (archived) `_ Typing-related Tools ==================== @@ -64,12 +65,12 @@ Type Checkers * `mypy `_, the reference implementation for type checkers. -* `pyre `_, written in OCaml and optimized for - performance. +* `pyre `_, a type checker written in OCaml and + optimized for performance. * `pyright `_, a type checker that emphasizes speed. -* `pytype `_, checks and infers types for - unannotated code. +* `pytype `_, a type checker that + checks and infers types for unannotated code. Development Environments ------------------------ @@ -89,13 +90,19 @@ Linters and Formatters * `flake8-pyi `_, a plugin for the `flake8 `_ linter that adds support for type stubs. +* `ruff `_, a linter built for speed, with support for + most of the ``flake8-pyi`` rules. Type-Hint and Stub Integration ------------------------------ -* `autotyping `_, a tool which infers simple types from their context and inserts them as inline type-hints. -* `merge_pyi `_, integrates .pyi signatures as inline type-hints in Python source code. - This is a thin wrapper around ``ApplyTypeAnnotationsVisitor`` from `libCST `_. +* `autotyping `_, a tool which + infers simple types from their context and inserts them as inline type-hints. +* `merge-pyi + `_, + a thin wrapper around ``ApplyTypeAnnotationsVisitor`` from + `libCST `_ that integrates .pyi + signatures as inline type-hints in Python source code. Typing PEPs ===========