ライブラリのドキュメントはどこにありますか?
ドキュメントファイルはどこにありますか? / docでそれらを見つけることができませんでした: https :
@ericbrandweinドキュメントの詳細はコード自体にあります: https :
@MichaelPereiraああ、/doc
ディレクトリに移動するからです😕
イントロダクションや目次などが配置されているので問題ありませんが、コードドキュメントの場所をもう少し明確にすることができます
READMEにドキュメントへのリンクが含まれていると便利です。
@gvanrossumどうぞ。
目に見えないところに隠されています。 :-(
バッジが多すぎる場合、これが問題になります。 ドキュメントはバッジよりも少し重要だと思うので、これは間違いなくreadmeでさらに拡張する必要があります。
READMEに加えて、ドキュメントへのリンクをここに追加するとよいでしょう。
IMHO @ gvanrossumと@tmshnが注目を集めています。
実際、 readme.md
の説明は、正しいドキュメントへのリンクにすぎない可能性があります(現在の説明には、非常によく知られているソースへのリンクしか含まれていないためです。
@jzelinskie 、アクセス権がある場合は、 @ gamefiendのhttps://github.com/PyGithub/PyGithub/pull/499を承認して
#499で閉鎖