No project description provided
Project description
numpydoc_decorator
This package allows you to build numpy-style docstrings programmatically and apply them using a decorator. This can be useful because:
-
Parts of your documentation, such as parameter descriptions, can be shared between functions, avoiding the need to repeat yourself.
-
Type information for parameters and return values is automatically picked up from type annotations and added to the docstring, avoiding the need to maintain type information in two places.
Work in progress.
Installation
pip install numpydoc_decorator
Usage
@@TODO
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
File details
Details for the file numpydoc_decorator-0.10.0.tar.gz.
File metadata
- Download URL: numpydoc_decorator-0.10.0.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.1 CPython/3.10.8 Linux/5.15.0-1033-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0d477c7924e819146ecd37157decaefe285c015068abeb9af530c2aa2826c4d5 |
|
| MD5 | 754dfb6cb489ebb73e1eea93a04186e6 |
|
| BLAKE2b-256 | b9f8fae0320c26d1715a058e9ff2d413d903f5ef8fcb1b3be77fc3c35cdd6a63 |
Provenance
File details
Details for the file numpydoc_decorator-0.10.0-py3-none-any.whl.
File metadata
- Download URL: numpydoc_decorator-0.10.0-py3-none-any.whl
- Upload date:
- Size: 5.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.1 CPython/3.10.8 Linux/5.15.0-1033-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3f9c581d623b3453e691d844e7244dc95a95e4cb312335429228423abf3b5149 |
|
| MD5 | 522bdd141ec27689348f3f93964671e5 |
|
| BLAKE2b-256 | 3e21a528a0011d5712eca442224c203ea5f3eefef69d019d74d9e56f358cc685 |
