-
Notifications
You must be signed in to change notification settings - Fork 0
Delete docstrings2md.py #63
Copy link
Copy link
Open
Milestone
Description
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
- Delete
docstrings2md.pyfrom repository root - Remove any references to the script in documentation or scripts
Dependencies
- Should be done alongside Set up mkdocs with mkdocstrings for API documentation #64 (new documentation setup)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels