python / python/docs-community

ABC documentation needs more details on usage

Offen
#132 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

question
Vorherrschende Sprache
Makefile
Sterne
55
Forks
26
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

I am trying to use Abstract Base Classes. But I find the documentation lacking on several points that makes the matter too 'abstract'.

For example. There is no explanation on making abstract objects mandatory by using exceptions

Or how to implement Iterable abstract bsse class that can be inherited from and still be usable.

Can someone shed more light onto this so that the documentation is more accessible?

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

Beginne damit, die Dokumentation zu Abstract Base Classes zu finden und ihre aktuelle Abdeckung abstrakter Objekte, Ausnahmen und der Vererbung von Iterable zu prüfen. Die Aufgabe ist erledigt, wenn die Dokumentation die angeforderten Verwendungsmuster klar erklärt und die Beispiele für Leser zugänglich macht; im Issue werden keine bestimmten Dateien oder Tests genannt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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