Change link targets in package descriptions#181
Conversation
Also replace a few references to PEPs in comments and docstrings.
| This is a [type stub package](https://typing.python.org/en/latest/tutorials/external_libraries.html) | ||
| for the {formatted_distribution} package. It can be used by type checkers | ||
| to check code that uses `{distribution}`. This version of | ||
| `{stub_distribution}` aims to provide accurate annotations for | ||
| `{distribution}{typeshed_version_spec}`. |
There was a problem hiding this comment.
is it worth also working in a link to https://typing.python.org/en/latest/spec/distributing.html#stub-only-packages ? The docs at https://typing.python.org/en/latest/tutorials/external_libraries.html maybe feel a bit "thin" right now
There was a problem hiding this comment.
I don't think users of type packages (who the description is targeted at) should be bothered with the spec, which is (or rather should be) only relevant for type checker authors. That said, if you think anything is missing from the tutorial (or if we should maybe add or replace the tutorial with a guide?), we could always extend it. I was also debating whether we should link the spec from the tutorial, but that also seemed to target the wrong audience.
There was a problem hiding this comment.
Makes sense, I'm happy to leave it as is
2 participants
Also replace a few references to PEPs in comments and docstrings.