Skip to content

Library doesn't have sufficient module documentation #123

Open
@maxdeviant

Description

@maxdeviant

Is your change request related to a problem? Please describe.
As described in the documentation section of the Library Guidelines, Contributors libraries are expected to have mostly complete module documentation, preferably uploaded to Pursuit.

This library currently doesn't have sufficient module documentation -- many publicly-exported types and functions don't have any documentation comments.

Describe the solution you'd like
The library needs to have documentation comments on the majority (and preferably all) public types and functions. Once updated, we should tag a release and upload new module documentation to Pursuit so that folks can use it.

Additional context
See the Governance repository

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueFirst-time contributors who are looking to help should work on these issues.type: documentationImprovements or additions to documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions