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

convert docs to YARD style #1

Open
josephholsten opened this issue Dec 2, 2009 · 2 comments
Open

convert docs to YARD style #1

josephholsten opened this issue Dec 2, 2009 · 2 comments

Comments

@josephholsten
Copy link
Owner

Makes docs play nice with rdoc.info
see http://rubydoc.info/gems/yard/file/docs/GettingStarted.md
@jwhitehorn
Copy link

What's the status of this? ;-)

@josephholsten
Copy link
Owner Author

yow, this is still pretty bad. Gotta love http://rubydoc.info/github/josephholsten/rets4r/RETS4R/Auth

The main reason for this is to document what the expected public interface is. At the moment, it's not clear where a user is supposed to start, and what methods are safe to call.

99% of the value would be from adding:

  • basic comments for the supported client api
  • @params and @return values
  • @deprecated for things that need to go away

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
No milestone
Development

No branches or pull requests
2 participants
@josephholsten @jwhitehorn