Add documentation - Githubissues

Shimmur / checker_cab

an extraction of assert_values_for

MIT License

23 stars 4 forks source link

Add documentation #7

Closed GeoffreyPS closed 2 years ago

GeoffreyPS commented 2 years ago

What does this do on a high level?

Includes documentation for the existing functionality of the library.

How was this change made?

[x] Document functions
[x] Document the CheckerCab module
[X] Update typespecs
[x] Document how to use the library in a project
[x] Document how to fetch the dependency

Why is this change necessary?

Libraries get much more use when they're documented.

How will this be verified?

[ ] The PR includes new tests
[X] Current test suite covers functionality
[ ] This has been tested locally
[ ] This has been tested in dev

Any additional information or special handling required on this PR?

motivational imagery Lisa Simpson struggles to write