ce-docstring-author

NumPy-style docstrings for public API functions are generated by enforcing canonical section ordering, including Summary, Parameters, Returns, Raises, Notes, References, and Examples, ensuring consistent structure and type annotations across modules.

The canonical section order for NumPy-style docstrings is Summary, Parameters, Returns, Raises, Notes, References, and Examples. This structure ensures clear descriptions of parameters, return values, exceptions, and usage examples.

To repair existing docstrings to follow a style guide, validate them against the canonical section order and contributor guidelines, then apply consistent structure, annotations, and CE-specific patterns to ensure standards compliance.

Yes, you can validate docstrings against contributor guidelines by checking for canonical section ordering, type annotations, and CE-specific patterns, receiving guidance for improvements where structure or examples are incomplete.

Yes, standardizing API documentation across multiple modules is achieved by loading templates and patterns from references to enforce CE-specific conventions, ensuring consistent docstring structure and annotations throughout libraries.

Automating docstring generation is limited to public CE symbols and relies on provided references for CE-specific conventions. It cannot generate accurate descriptions without sufficient context about the function's parameters and return values.