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.