jwir3 / gitbranchhealth

A tool for determining the health of branches in a git repository.
Mozilla Public License 2.0
0 stars 1 forks source link

Add API documentation #23

Open jwir3 opened 10 years ago

jwir3 commented 10 years ago

In a similar vein to GitPython, we should add documentation for our API. In addition, this gives us the opportunity to write a tutorial. This issue covers the research necessary to perform this task and the writing of both the in-code documentation and the markup documentation.