Skip to content

Let's add some code docs #70

@joecorcoran

Description

@joecorcoran

The documentation in the readme is good enough for people to understand the purpose of the library and how to use it, however the code itself is largely without documentation and this might be putting off potential contributors / bug reporters.

I suggest YARD unless anyone has a better idea. Thoughts, anyone?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions