Lets make sure you don't forget to document this time.
Project description
# DocUMust
#### Lets make sure you don't forget to document this time.
- [About](#about)
- [Usage](#usage)
- [Installation](#installation)
## About
<b>DocUMust</b> is a CLI tool that warns you about
undocumented modules/classes/functions in your project
following [PEP 257](#https://www.python.org/dev/peps/pep-0257)
guidelines.
<p align="center">
<img src="" alt="DocUMust Demo gif"/>
</p>
## Installation
You can install <b>documust</b> with pip:
> pip install documust
## Usage
> cd Project/
>
> documust -r
## Options
- -r: Run recursively over your project
#### Lets make sure you don't forget to document this time.
- [About](#about)
- [Usage](#usage)
- [Installation](#installation)
## About
<b>DocUMust</b> is a CLI tool that warns you about
undocumented modules/classes/functions in your project
following [PEP 257](#https://www.python.org/dev/peps/pep-0257)
guidelines.
<p align="center">
<img src="" alt="DocUMust Demo gif"/>
</p>
## Installation
You can install <b>documust</b> with pip:
> pip install documust
## Usage
> cd Project/
>
> documust -r
## Options
- -r: Run recursively over your project
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
DocUMust-0.0.7.tar.gz
(3.3 kB
view hashes)
