Info-Gewinn, Modul-Dokumentation

[Strawk]

Hallo Nutzer!

Welches sind nochmal die Standard-Python-Informationsquellen? Woher beziehe ich die Dokumentation eines Moduls? Z.B. des Moduls gpxpy? Was ist ein __docstring__? Welches sind die Grenzen der help-Funktion im Python-Interpreter?

Grüße
Strawk

[Bolitho]

Google ist hier dein Freund.
In der Regel findest du Antworten im englischsprachigen Bereich.
- gpxpy, z.B. im GitHub des Moduls
- Docstring steht in den PEPs (Python Enhancement Proposals)
- Help in der Python Dokumentation

[__blackjack__]

• Standard-Informationsquelle für Python selbst ist die Python-Dokumentation.
• Dokumentation eines Moduls bekommt man üblicherweise dort, wo das Modul her kommt. Notfalls über die Docstrings, oder falls es die auch nicht gibt, der Code in dem Modul. Bei einigen Modulen die irgendwelche Standards umsetzen oder Bibliotheken wrappen, die in anderen Programmiersprachen geschrieben sind, gibt es dort dann Dokumentation. Bei den GUI-Rahmenwerken (Gtk, Qt, Tk, wxWidgets, …) hilft zum Beispiel die Dokumentation der originalen Bibliotheken.
• Speziell für `gpxpy` hat man im Python Package Index schon die ganze Dokumentation die das Modul zu bieten hat. Auf der Github-Seite steht die auch noch mal. Ansonsten gilt dort das was ich im letzten Punkt über Standards gesagt habe: das Modul parst GPX-Dateien, es könnte also hilfreich sein wenn man die Dokumentation/Spezifikation zu diesem standardisierten Dateiformat kennt.
• „Documentation strings“ a.k.a. docstrings werden werden im Python-Tutorial in der Python-Dokumentation erwähnt, haben in der Python-Dokumentation einen Eintrag im Glossar, werden im Style Guide for Python Code angesprochen, und haben ein eigenes PEP PEP 257 -- Docstring Conventions. Einen Wikipedia-Eintrag gibt es für den Begriff ebenfalls.
• Die `help()`-Funktion wird auch im Tutorial erwähnt, und ist natürlich dokumentiert, und wenn man sie mal aufruft: das interaktive Hilfssystem enthält doch tatsächlich auch Hilfe für das Hilfssystem.

Ich würde also dem ersten Satz von Bolitho etwas weniger Gewicht zuordnen wollen: Suchmaschine erst wenn man in der offensichtlichen Dokumentation also für Python selbst + PEPs + Howtos + Python.org-Wiki, und für externe Module deren offizielle Dokumentation und offizielle Dokumentation zu den Bibliotheken/Techniken die damit zusammenhängen, nichts passendes gefunden hat. Google findet das manchmal nicht, oder nicht an erster Stelle, dafür aber seit dem mit dem Raspberry Pi die ”PHP-isierung” Einzug gehalten hat, auch gerne mal ganz schreckliche Infos und Beispiele.