Pygithub: Wo ist die Dokumentation???

http://pygithub.readthedocs.io/en/latest/introduction.html

Wo sind die Dokumentationsdateien? Ich konnte sie nicht in /doc finden: https://github.com/PyGithub/PyGithub/tree/master/doc. Sie brauchen ein Update, und ich würde gerne eine PR machen, wenn sie verfügbar wären

@ericbrandwein Die Dokumentationsdetails befinden sich im Code selbst: https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159 -L166

@MichaelPereira oh /doc Verzeichnis in diesem Repo 😕

Das ist in Ordnung, denn hier befinden sich die Einführung, das Inhaltsverzeichnis usw., aber die Position der Codedokumentation könnte etwas expliziter sein

Aber wenn ich hierher gehe: http://pygithub.readthedocs.io/en/latest/apis.html und auf diese Schaltfläche https://github.com/PyGithub/PyGithub/blob/ master/doc/apis.rst

Wäre schön, wenn die README einen Link zu den Dokumenten enthalten würde.

@gvanrossum Na los.

Versteckt in Sichtweite. :-(

Das ist das Problem, wenn Sie zu viele Abzeichen haben. Ich denke, dass Docs etwas wichtiger ist als ein Abzeichen, daher sollte dies in der Readme auf jeden Fall erweitert werden.

Neben der README wäre es schöner, wenn der Link zum Dokument hier hinzugefügt würde:

IMHO @gvanrossum und @tmshn sind genau richtig .
Tatsächlich könnte die Beschreibung in readme.md nichts anderes sein als der Link zu den richtigen Dokumenten (da die aktuelle Beschreibung nur Links zu sehr bekannten Quellen enthält.
@jzelinskie , wenn Sie den Zugriff haben, genehmigen Sie bitte https://github.com/PyGithub/PyGithub/pull/499

Geschlossen von #499