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

Provide more information in API docstrings #7

Open
flpa opened this issue Feb 17, 2015 · 1 comment
Open

Provide more information in API docstrings #7

flpa opened this issue Feb 17, 2015 · 1 comment

Comments

@flpa
Copy link

flpa commented Feb 17, 2015

In my opinion, documentation of API methods should be extended so that it's easier to use them without looking up their source or experimenting.

For example, get-subreddit-new is described with "Gets json data for /r/< sub>/new. Optional user."
I think it'd be helpful to mention that the function returns a list of link objects.

@jperson
Copy link
Owner

jperson commented Feb 18, 2015

I agree, the documentation is pretty minimal.

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