python-annotated-doc 0.0.4-1
Package Information
| Description | document parameters, class attributes, return types, and variables inline, with `Annotated` Import `Doc` and pass a single literal string with the documentation for the specific parameter, class attribute, return type, or variable. Reasons to use annotated-doc: * No micro-syntax to learn for newcomers, it’s just Python syntax. * Editing would be already fully supported by default by any editor (current or future) supporting Python syntax, including syntax errors, syntax highlighting, etc. * Rendering would be relatively straightforward to implement by static tools (tools that don't need runtime execution), as the information can be extracted from the AST they normally already create. * Deduplication of information: the name of a parameter would be defined in a single place, not duplicated inside of a docstring. * Elimination of the possibility of having inconsistencies when removing a parameter or class variable and forgetting to remove its documentation. * Minimization of the probability of adding a new parameter or class variable and forgetting to add its documentation. * Elimination of the possibility of having inconsistencies between the name of a parameter in the signature and the name in the docstring when it is renamed. * Access to the documentation string for each symbol at runtime, including existing (older) Python versions. * A more formalized way to document other symbols, like type aliases, that could use Annotated. * Support for apps using FastAPI, Typer and others. * AI Accessibility: AI tools will have an easier way understanding each parameter as the distance from documentation to parameter is much closer. |
|---|---|
| Maintainer | Sandro Tosi <morph@debian.org> |
| Changed By | Sandro Tosi <morph@debian.org> |
| Sponsor | morph@debian.org |
| Distribution | unstable |
| Architecture | all |
| VCS | git: https://salsa.debian.org/morph/python-annotated-doc.git (browse) |
| Tracker | https://tracker.debian.org/pkg/python-annotated-doc |
| Uploaded | 3 hours ago |
New Package Report
.changes
| Architecture | source all |
|---|---|
| Distribution | unstable |
| Date | Sun, 12 Apr 2026 00:44:02 -0400 |
| Source | python-annotated-doc |
| Version | 0.0.4-1 |
| Changed-By | Sandro Tosi |
Changelog
python-annotated-doc (0.0.4-1) unstable; urgency=low . * Initial release, autogenerated by py2dsp/5.20260225
.dsc
| Package-List | python3-annotated-doc deb python optional arch=all |
|---|---|
| Section | python |
| Priority | optional |
| Component | main |
debian/copyright
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: annotated-doc Upstream-Contact: None <=?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>> Source: https://github.com/fastapi/annotated-doc Files: * Copyright: (c) 2025 Sebastián Ramírez License: None Files: debian/* Copyright: 2026 Sandro Tosi <morph@debian.org> License: None License: None The MIT License (MIT) . Copyright (c) 2025 Sebastián Ramírez . Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: . The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. . THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.