Description
The docstrings2md.py script is brittle and produces poorly formatted documentation. It should be deleted as part of moving to proper documentation tooling.
Problems with Current Script
- Hardcoded string parsing (
signature.split("->"))
- Produces ugly type representations (
Union[Literal['x'], Literal['y']])
- Line wrapping issues in generated markdown
- No support for complex type annotations
Acceptance Criteria
Dependencies
Description
The
docstrings2md.pyscript is brittle and produces poorly formatted documentation. It should be deleted as part of moving to proper documentation tooling.Problems with Current Script
signature.split("->"))Union[Literal['x'], Literal['y']])Acceptance Criteria
docstrings2md.pyfrom repository rootDependencies