Metadata-Version: 2.1
Name: numpydoc-decorator
Version: 0.10.0
Summary: 
Author: Alistair Miles
Author-email: alimanfoo@googlemail.com
Requires-Python: >=3.7,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: typing_extensions
Description-Content-Type: text/markdown

# 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

