python / python/typing

Libraries document

Open
#905 0 comments 0 reactions 1 assignee View on GitHub

@srittau is already working on this.

Since Oct 7, 2021.

topic: documentation
Dominant language
Python
Stars
1.8k
Forks
302
Avg merge
23h
Merged PRs (30d)
8

Description

Some thoughts copied from srittau/type-stub-pep#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 python/typing#851).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.