Dimana Dokumentasi untuk perpustakaan??
Di mana file dokumentasi? Saya tidak dapat menemukannya di /doc: https://github.com/PyGithub/PyGithub/tree/master/doc. Mereka membutuhkan pembaruan, dan saya dengan senang hati akan membuat PR jika tersedia
@ericbrandwein Detail dokumentasi ada dalam kode itu sendiri: https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159 -L166
@MichaelPereira oh bagus, maka dokumentasi di ReadTheDocs perlu diperbarui, karena tombol "edit di github" mengirim saya ke direktori /doc
di repo ini
Tidak apa-apa karena ini adalah tempat pengenalan, daftar isi, dll berada, tetapi lokasi dokumentasi kode dapat dibuat sedikit lebih eksplisit
Tetapi ketika saya pergi ke sini: http://pygithub.readthedocs.io/en/latest/apis.html , dan klik tombol itu, saya akan dibawa ke 404: https://github.com/PyGithub/PyGithub/blob/ master/doc/apis.rst
Akan lebih baik jika README berisi tautan ke dokumen.
@gvanrossum Ini dia.
Tersembunyi di depan mata. :-(
Itulah masalahnya ketika Anda memiliki terlalu banyak lencana. Saya pikir dokumen sedikit lebih penting daripada lencana, jadi ini pasti harus diperluas lebih banyak di readme.
Selain README, akan lebih baik jika link ke dokumen ditambahkan di sini:
IMHO @gvanrossum dan @tmshn tepat.
Faktanya, deskripsi di readme.md
tidak lebih dari tautan ke dokumen yang benar.(karena deskripsi saat ini hanya berisi tautan ke sumber yang sangat terkenal.
@jzelinskie , jika Anda memiliki akses, Mohon setujui @gamefiend https://github.com/PyGithub/PyGithub/pull/499
Ditutup oleh #499