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.

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

Enrich and standardize documents. #277

Open
kannapoix opened this issue Aug 27, 2018 · 1 comment
Open

Enrich and standardize documents. #277

kannapoix opened this issue Aug 27, 2018 · 1 comment

Comments

@kannapoix
Copy link

README says

Documentation is generated using yardoc

but I sees RDoc like sysntax, like +tx+.
Also there many methods which has no document and no description and class info about a parameter.
Now you are revamping this repository, so I think this is good time to enrich and standardize documents.
YARD or RDoc?

Any thoughts?

@etscrivner
Copy link

Feel free to contribute if this is important to you :) Otherwise, we will get to this as we have time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants