Generate Docstrings with type-hint informations
Project description
docstring_generator
Auto generate docstring from type-hints
How to use it
gendocs file.py
gendocs mydir/
Options
style
--style- Docstring style [numpy, rest]. [default: numpy]
ignore-classes
--ignore-classes- when used then no class will be modified
ignore-functions
--ignore-functions- when used then no function will be modified this
- !important class methods are no functions in this context
Examples
- An example can be found under examples
Installing
- pip install docstring-generator
Versioning
- For the versions available, see the tags on this repository.
Authors
- Felix Eisenmenger
License
- This project is licensed under the MIT License - see the LICENSE.md file for details
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
Built Distribution
Close
Hashes for docstring_generator-0.2.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 91bef83d927e9bba160899e0aa99ccd85509a35f1033e60c16aff129e57679cc |
|
| MD5 | 9e06567293829d2f00bba8f38073b77b |
|
| BLAKE2b-256 | 3d35b810364e832372ac8d54c7ebfc962c5b3c219776d01cc412cd8e6bc08173 |
Close
Hashes for docstring_generator-0.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4b17de1a10c0573e849c3012184a2ac05eac844293147b0dcde28f0d7c806e90 |
|
| MD5 | 549ed3a719cbe8c592d8bbea23998583 |
|
| BLAKE2b-256 | bbc1a5d8907efafa3ffd3d5b8cbdb61512e539ecc7b159dfb9feea17f801a381 |
