Pygithub: ドキュメントはどこにありますか?

作成日 2016年10月23日  ·  13コメント  ·  ソース: PyGithub/PyGithub

ライブラリのドキュメントはどこにありますか?

全てのコメント13件

ドキュメントファイルはどこにありますか? / docでそれらを見つけることができませんでした: https

@ericbrandweinドキュメントの詳細はコード自体にあります: https

@MichaelPereiraああ、/docディレクトリに移動するからです😕

イントロダクションや目次などが配置されているので問題ありませんが、コードド​​キュメントの場所をもう少し明確にすることができます

しかし、ここに行くと: httphttps

READMEにドキュメントへのリンクが含まれていると便利です。

@gvanrossumどうぞ

2016-11-01 19-35-43

目に見えないところに隠されています。 :-(

バッジが多すぎる場合、これが問題になります。 ドキュメントはバッジよりも少し重要だと思うので、これは間違いなくreadmeでさらに拡張する必要があります。

READMEに加えて、ドキュメントへのリンクをここに追加するとよいでしょう。
url_here

IMHO @ gvanrossum@tmshn注目集めています。
実際、 readme.mdの説明は、正しいドキュメントへのリンクにすぎない可能性があります(現在の説明には、非常によく知られているソースへのリンクしか含まれていないためです。
@jzelinskie 、アクセス権がある場合は、 @ gamefiendhttps://github.com/PyGithub/PyGithub/pull/499を承認して

#499で閉鎖

このページは役に立ちましたか?
0 / 5 - 0 評価