Package python3-module-annotated_doc: Information

Document parameters, class attributes, return types, and variables
inline, with Annotated.

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.

Package python3-module-annotated_doc: Information

Last changed