python / python/typing

Libraries document

Offen
#905 0 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@srittau arbeitet bereits daran.

Seit 07.10.2021.

topic: documentation
Vorherrschende Sprache
Python
Sterne
1.8k
Forks
302
Ø Merge
23 Std.
Gemergte PRs (30 T.)
8

Beschreibung

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).

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.