Skip to content

doc: further documentation compliance and other small changes #10

Description

@OliverBrotchie

Currently, the documentation is far from the standards set out in Rust's Result and Option. The readme should be improved and include how to use this library via node. The JSDoc examples should also be updated and expanded upon.

Suggested Changes:

  • Bring documentation in line with Rust's for Result and Option.
  • Improve upon the readme and give examples of node.js usage.
  • Further, expand upon the JSDoc examples to better illustrate the uses of this library.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions