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

Better documentation #86

Open
seancookr opened this issue Aug 24, 2015 · 1 comment
Open

Better documentation #86

seancookr opened this issue Aug 24, 2015 · 1 comment
Milestone

Comments

@seancookr
Copy link

@rubenrails @javierg @netlogics @norcal82 what areas of the code have little to no documentation? what should we have documented better. Lets discuss so we can make focused Issues for each thing that needs better documentation

@seancookr seancookr added this to the 1.0 RC milestone Aug 24, 2015
@rubenrails
Copy link

This is the what the README says about the view method:

#Return a User object based on the custom view.
user = User.view 'view_name', {key: ["a", "b", "c"], reduce: true}

That's confusing, as it doesn't return an object of the given class, but rather an String (request response). Also, it was confusing to me the expected format of the view_name to be provided. I'll send a PR with proper doc changes to fix this.

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

No branches or pull requests

2 participants