-
Notifications
You must be signed in to change notification settings - Fork 10
Closed
Labels
good first issueFirst-time contributors who are looking to help should work on these issues.First-time contributors who are looking to help should work on these issues.type: documentationImprovements or additions to documentation.Improvements or additions to documentation.
Description
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's documentation could be improved in primarily two ways:
- clarifying what the These type is (basically reuse the readme's description)
- documenting what the instances do by providing examples
Describe the solution you'd like
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 for more information about requirements in the Contributors organization.
Metadata
Metadata
Assignees
Labels
good first issueFirst-time contributors who are looking to help should work on these issues.First-time contributors who are looking to help should work on these issues.type: documentationImprovements or additions to documentation.Improvements or additions to documentation.