/docstring_writer

A documentation tool for writing docstrings on python files

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

docstring_writer

A documentation tool for writing docstrings on python files

Usage

install repository with `pip install .``

once installed use docstring_writer <file> or docstring_writer -r <directory> (WIP)

Project planning

[x] create sample files

[x] create system for reading files

[x] create system for chunking files into functions

[x] create system for adding documentation to functions

[] create system for re-assembling files