Skip to content

Add an option to emit warnings if public objects don't have a docstring #45

Open
@astrofrog

Description

@astrofrog

As originally mentioned in astropy/astropy-helpers#195, it might be useful to have a way to be strict about requiring public functions, methods, and classes to have docstrings, so that we don't end up with empty docstrings in the API docs generated by sphinx-automodapi.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions