Improve the generated package description #150
Conversation
Reshuffle the sentences: The intro now contains the most important information for users: a general description, the upstream version, and the tested type checker versions. General information about typeshed, bug tracker info, and metadata (the commit hash) was moved to the outro. Additional information (extra description, the notice that a package is obsolete) remains between the intro and outro. Also explicitly mention the typeshed project (in the outro) and hide URLs in labeled links.
|
Before: Typing stubs for psycopg2This is a PEP 561 type stub package for the psycopg2 package. It can be used by type-checking tools like mypy, pyright, pytype, PyCharm, etc. to check code that uses This version of See https://github.com/python/typeshed/blob/main/README.md for more details. This package was generated from typeshed commit b2f68ec2feff500ea9e8983396cead54218bb99c and was tested with mypy 1.11.2, pyright 1.1.385, and pytype 2024.10.11. After: Typing stubs for psycopg2This is a PEP 561 type stub package for the psycopg2 package. It can be used by type-checking tools like mypy, pyright, This version of This package is part of the typeshed project. All fixes for types and metadata should be contributed there. See the README for more details. The source for this package can be found in the This package was generated from typeshed commit b2f68ec2feff500ea9e8983396cead54218bb99c. |
stub_uploader/build_wheel.py
Outdated
| The source for this package can be found at | ||
| https://github.com/python/typeshed/tree/main/stubs/{distribution}. All fixes for | ||
| types and metadata should be contributed there. | ||
| for `{distribution}{typeshed_version_spec}` and was tested |
There was a problem hiding this comment.
I feel this may be putting too much emphasis on the type checker versions we test with. There are occasional exceptions, but most stubs are going to work fine with older versions. Maybe move the info about type checker versions further down to where we mention the typeshed commit?
Also, a bit further up (can't comment there), we mention a list of type checkers; feels like we should also mention Pyre there.
There was a problem hiding this comment.
Last time I suggested mentioning Pyre, the objection was that we don't test Pyre in CI: #84 (comment). But I'm certainly still in favour of mentioning it.
There was a problem hiding this comment.
New take:
Typing stubs for psycopg2
This is a PEP 561 type stub package for the psycopg2 package. It can be used by type-checking tools like mypy, pyright, pytype, Pyre, PyCharm, etc. to check code that uses psycopg2. This version of types-psycopg2 aims to provide accurate annotations for psycopg2~=2.9.10.
... additional info (if any) ...
This package is part of the typeshed project. All fixes for types and metadata should be contributed there. See the README for more details. The source for this package can be found in the stubs/psycopg2 directory.
This package was tested with mypy 1.11.2, pyright 1.1.385, and pytype 2024.10.11. It was generated from typeshed commit b2f68ec2feff500ea9e8983396cead54218bb99c.
Reshuffle the sentences: The intro now contains the most important
information for users: a general description, the upstream version,
and the tested type checker versions. General information about
typeshed, bug tracker info, and metadata (the commit hash) was
moved to the outro. Additional information (extra description, the
notice that a package is obsolete) remains between the intro and
outro.
Also explicitly mention the typeshed project (in the outro) and
hide URLs in labeled links.