dodger487/dplython

Add documentation

Open

#21 opened on Apr 7, 2016

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (762 stars) (57 forks)batch import
help wanted

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonbasic understanding of dplython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.