a new way to do python code documentation
Project description
archives is a new style of python code documentation, as well as a linter for the documentation itself. It can help you ensure that your docstrings in your classes and functions stay up to date, and that they adequately explain their purpose, arguments, and return value.
Features
(coming soon) linter for docstrings
(coming soon) documentation generator
Usage
Installation
pip install archivesTesting
Tests can (almost) be run with tox!
# run tests
toxTodo
more rules
better system for multi-check rules
more output formats
documentation generator
tests
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
archives-0.2.tar.gz
(2.2 kB
view hashes)
