Auto generate docstring from type-hints.
Project description
docstring_generator
Auto generate docstring from type-hints for python functions and class methods.
How to use it
gendocs_new file.py
gendocs_new mydir/
Options
style
--style
- Docstring style [numpy, google, rest]. [default: numpy]
Add additional information before running gendocs_new
- when adding
$<num>
into your docstring these will then be replaced with parameter at this index - Example:
from typing import List
def foo(val_a: int, val_b: List[int]):
"""
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
$1 Lorem ipsum dolor sit amet
$2 nonumy eirmod tempor invidun
"""
will become (here with numpy style)
from typing import List
def foo(val_a: int, val_b: List[int]):
"""
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
Parameters
----------
val_a : argument of type int
Lorem ipsum dolor sit amet
val_b : argument of type List(int)
nonumy eirmod tempor invidun
"""
FAQ
what happens if I re-run the docstring creation?
- nothing if all stays the same, changed parameter descriptions will be ignored only changes of the function header will be used
Examples
- An example can be found under examples
Installing
- pip install docstring-generator
Versioning
- For the versions available, see the tags on this repository.
Support for older version
- the previous command
gendocs
is still supported for this version.
Authors
- Felix Eisenmenger
License
- This project is licensed under the MIT License - see the LICENSE.md file for details
Project 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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7511f78dcd7f74d41c90020a6ffe2e14cbb8b89c978def8967523c19ab10a841 |
|
MD5 | 945108c9f30d12cc41ee6dd4a8e60bfb |
|
BLAKE2b-256 | d776bb73aaf3adbd0bc2a6a61332a3f0d19cc1d735cec2cf56966948cd5c3195 |
Close
Hashes for docstring_generator-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db37386567f4680f7d4b08fb5dc0c8e38a927ee50da2eaed2a30a627afedc0e0 |
|
MD5 | 06c5c1283f13d4e437b907ba475ebbcd |
|
BLAKE2b-256 | b08c4d8f92144401c1e9c250d29b8333b3fe34e1f31a388a9c97b83fca1a8ffc |