python / python/typing

Should we add links to existing resources?

Offen
#1,046 7 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

I was catching up on a long python-dev discussion about the state of type annotations, and noticed that @gvanrossum had asked for a list of easily discoverable (by search engines) resources regarding typing.

I collected up this note:
https://gist.github.com/stroxler/ade7977ed07e27448222a468796bc467

Would we want to include a couple of the best links (in particular the RealPython blog, maybe the LogRocket one as well) in our docs? At least at this time, those may actually be the two best getting-started tutorials. The mypy docs are much more thorough and incredibly useful as a reference, but aren't really written in a manner where a beginner could easily skim them end-to-end.

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.

Rechercherichtung

Lies zunächst das verlinkte Gist und die vorhandene Dokumentation zur Typisierung, und vergleiche dann die vorgeschlagenen Tutorials von Real Python und LogRocket mit dem Referenzmaterial von mypy. Bestätige, welche Ressourcen für Anfänger geeignet sind, und identifiziere die Dokumentationsseite, auf der externe Links zum Einstieg platziert werden sollen. Als erledigt gilt die Aufgabe, wenn die ausgewählten Links mit klaren Beschreibungen hinzugefügt wurden oder im Issue festgehalten ist, warum sie nicht hinzugefügt werden sollten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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