sigdoc
Inline documentation of parameters, returns, and raises.
Documenting function parameters and returns in docstrings is tedious - type hints need to be duplicated, the order is hard to maintain, and added/removed params and returns easily get out of sync.
sigdoc provides helpers to automatically extend docstrings at runtime by annotating a function's parameter and return type hints "inline". This inline notation greatly increases the locality of the code and documentation, reducing the maintenance burden.
As this relies on runtime generation, the full docstring will only be visible to runtime inspection. Luckily, this includes help(...) in python, ipython, and jupyter (including Shift+Tab). Static analysis tools (such as many IDEs) won't know how to decipher the full docstring, but often show the function's signature, which will still have all of the useful information included.
Installation
sigdoc can be installed from PyPI on python 3.9+ with pip install sigdoc.
Contributing
Everyone is welcome to contribute - feel free to open an issue or PR!
1 maintainer
Metadata
1 maintainer
Release files for sigdoc 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sigdoc-0.0.2.tar.gz | 6.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sigdoc-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.0 kB
Release files / sigdoc-0.0.2.tar.gz
| Download URL | sigdoc-0.0.2.tar.gz |
|---|---|
| Size | 6.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
00110aa178e060d2968bb27b4aedcbe0541104e35cbb9e5d21f567b1f0913cd2
|
|
BLAKE2b-256 checksum How to use checksums |
1bb66a5b490ce4e61959613744cafd5365a36d997a76532e012f20d569b18bb6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.10.10 Darwin/22.3.0
|
Release files / sigdoc-0.0.2-py3-none-any.whl
| Download URL | sigdoc-0.0.2-py3-none-any.whl |
|---|---|
| Size | 6.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbd3cb15dca0471a6026901d8821d19f1cb4287b4953e2effbb8c2caace46ec3
|
|
BLAKE2b-256 checksum How to use checksums |
536fd62d2c068818057be6c10a986dd3e0666ce64f49a91f0b834ed26990e325
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.10.10 Darwin/22.3.0
|
Security for sigdoc 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
