dodger487/dplython

Add documentation

Open

#21 建立於 2016年4月7日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)Python (762 star) (57 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.