Skip to content
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

Let's add some code docs #70

Open
joecorcoran opened this issue Dec 10, 2015 · 0 comments
Open

Let's add some code docs #70

joecorcoran opened this issue Dec 10, 2015 · 0 comments
Milestone
v3

Comments

@joecorcoran
Copy link
Collaborator

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?
@joecorcoran joecorcoran added this to the v3 milestone Dec 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3
Development

No branches or pull requests
1 participant
@joecorcoran