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

Documentation refresh #2

Open
jbgo opened this issue Aug 23, 2015 · 0 comments
Open

Documentation refresh #2

jbgo opened this issue Aug 23, 2015 · 0 comments
Labels
enhancement
Milestone
v1 release

Comments

@jbgo
Copy link
Owner

jbgo commented Aug 23, 2015

  • edit/revise the README to reflect the actual public interface
  • be sure to document all configuration options (create a wiki page if needed)
  • Write doc comments for all public classes, methods, constants, etc.
  • Add chasqui to rubydoc.info
  • update the examples to reflect the actual public interface https://github.com/jbgo/chasqui/tree/master/examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
v1 release
Development

No branches or pull requests
1 participant
@jbgo