New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs pass and nitpick cleanup #16

Closed

wokket opened this issue Aug 7, 2021 · 0 comments · Fixed by #44

Milestone

Owner

wokket commented Aug 7, 2021 •

edited

Loading

If it's going to be used in prod the docco needs to be stepped up as well.

General usage docco (creating a message, retrieving values, etc)
Move tests that make sense into function docs as examples of usage
Hide any struct vars that can be easily (information hiding), expose via funcs instead
Clean up some of the dupe methods (value vs as_str etc)

The text was updated successfully, but these errors were encountered:

wokket added this to the 0.6 milestone

wokket changed the title ~~Docs pass~~ Docs pass and nitpick cleanup

wokket added a commit that referenced this issue


          feat #16 - Lots of work on the docs, and some general cleanup

5fbe0b9

wokket linked a pull request

that will close this issue

feat #16 - Lots of work on the docs, and some general cleanup #44

Merged

wokket closed this as completed in #44

wokket added a commit that referenced this issue


          feat #16 - Lots of work on the docs, and some general cleanup (#44)

e1b8456

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment