Skip to content

Improve docstrings on public plugin assertion methods #35

@elijahr

Description

@elijahr

Plugin assertion methods (`assert_request()`, `assert_command()`, etc.) have minimal docstrings. Add comprehensive docstrings with Parameters, Returns, Raises, and Examples sections.

These will be automatically rendered in the mkdocs site via mkdocstrings and provide IDE tooltips. Start with HttpPlugin and DatabasePlugin as the highest-traffic plugins.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions