Skip to content

Request for short clarification on design principles #50

@1kastner

Description

@1kastner

Description

Other modules, such as https://github.com/agronholm/sphinx-autodoc-typehints, also extend the options of the sphinx documentation. However, they do not use decorators in the code. Instead, they listen to sphinx events. This way, only the people who build the docs need to have the module installed. When using the decorator approach like in this module, each user needs to install it just to run the code. Furthermore, the decorators are invoked every time the the module is imported, even if it is only used programmatically and no documentation is required. What were the reasons that led to this decorator-based module design? A small explanation in the Readme would be very great! Thank you very much for the clarification.

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions