Skip to content

Libraries document #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
srittau opened this issue Oct 7, 2021 · 0 comments
Open

Libraries document #905

srittau opened this issue Oct 7, 2021 · 0 comments
Assignees
Labels
topic: documentation Documentation-related issues and PRs

Comments

@srittau
Copy link
Collaborator

srittau commented Oct 7, 2021

Some thoughts copied from srittau/peps#94:

  • Convert to restructed text to fit with the rest of the typing docs (and Python docs in general).
  • Update a few recommended practices like using list instead of List.
  • Add a link to the existing stubs document.

In the long run, I think this would make a good basis for a "How to type annotate a library" document. It makes sense to me to split out some chapters into separate documents, possibly merging them with existing or new texts. For example, the best practices section could be merged with some recommendations from the stubs document to form a new general "best practices" document (see also #851).

@srittau srittau added the topic: documentation Documentation-related issues and PRs label Oct 7, 2021
@srittau srittau self-assigned this Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Documentation-related issues and PRs
Projects
None yet
Development

No branches or pull requests

1 participant