dodger487/dplython

Add documentation

Open

#21 opened on 2016年4月7日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Python (762 stars) (57 forks)batch import
help wanted

説明

This is a note mainly for me. Well, also for you to see, which will pressure me to do it quickly so I am not embarrassed by not having done it. So sort of for you, but mainly for me.

I need to add some good docs to pythonhosted or somewhere...

If you are interested in helping out with documentation, than this note can be for you even more! Just comment here or ping me on Twitter @dodger487

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Pythonbasic understanding of dplython
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
Check the existing documentation in the repository (e.g., README.md, any docs folder) and review the comments in issue #21 for specific documentation needs. The maintainer mentioned adding docs to pythonhosted, so consider using tools like Sphinx to generate documentation from docstrings. Look at similar libraries' documentation for structure inspiration.