Pygithub: أين الوثائق ؟؟؟

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

أين ملفات التوثيق؟ لم أتمكن من العثور عليها في / doc: https://github.com/PyGithub/PyGithub/tree/master/doc. إنهم بحاجة إلى تحديث ، وسأقوم بكل سرور بتقديم علاقات عامة إذا كانت متوفرة

ericbrandwein تفاصيل التوثيق موجودة في الكود نفسه: https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159 -L166

MichaelPereira رائع ، إذن الوثائق الموجودة في ReadTheDocs تحتاج إلى تحديث ، لأن زر "التحرير على github" يرسلني إلى الدليل /doc في الريبو هذا 😕

وهو أمر جيد لأن هذا هو المكان الذي توجد فيه المقدمة وجدول المحتويات وما إلى ذلك ، ولكن يمكن توضيح مكان توثيق الكود بشكل أكثر وضوحًا

ولكن عندما أذهب هنا: http://pygithub.readthedocs.io/en/latest/apis.html ، وانقر على هذا الزر ، يأخذني إلى 404: https://github.com/PyGithub/PyGithub/blob/ ماجستير / مستند / apis.rst

سيكون لطيفًا إذا احتوى برنامج README على رابط للمستندات.

gvanrossum ها أنت

مخبأة على مرأى من الجميع. :-(

هذه هي المشكلة عندما يكون لديك الكثير من الشارات. أعتقد أن المستندات أهم قليلاً من الشارة ، لذا يجب بالتأكيد توسيعها في الملف التمهيدي.

بالإضافة إلى README ، سيكون من الأفضل إضافة رابط المستند هنا:

IMHOgvanrossum و tmshn على الفور.
في الواقع ، لا يمكن أن يكون الوصف في readme.md أكثر من رابط للمستندات الصحيحة. (لأن الوصف الحالي يحتوي فقط على روابط لمصادر فائقة الشهرة.
jzelinskie، إذا كان لديك وصول، الرجاء الموافقةgamefiend الصورة https://github.com/PyGithub/PyGithub/pull/499

مغلق برقم 499