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

Document all things #192

Closed
hexgnu opened this issue Dec 12, 2013 · 4 comments
Closed

Document all things #192

hexgnu opened this issue Dec 12, 2013 · 4 comments

Comments

@hexgnu
Copy link
Owner

hexgnu commented Dec 12, 2013

The Linkedin gem is ridiculously undocumented. I would love to get some more documentation around all the methods
@hundredwatt
Copy link
Collaborator

@hexgnu I'm gonna work on this since it would be helpful to our team. A couple things before I start:

  1. Do you mind if I swap out rdoc for yard? This would require changing a development dependency and the Rakefile
  2. I'd like to re-organize the methods in the api/ directory from the 2 modules we have now to many modules that match the organization of API methods in the LinkedIn documentation (see sidebar on this page: http://developer.linkedin.com/documents/rest)

Do you have any thoughts on either of these points?

@hexgnu
Copy link
Owner Author

hexgnu commented Jan 16, 2014

sounds like a great plan!

@hundredwatt
Copy link
Collaborator

I started working on this here: https://github.com/hundredwatt/linkedin/tree/docs

I hope to finish up documenting all the API methods today. Would love any feedback!

@hundredwatt hundredwatt mentioned this issue Jan 18, 2014
Merged
@hundredwatt
Copy link
Collaborator

Closing since #204 was merged

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
@hundredwatt @hexgnu