search

amco / dolly

Not an ORM for CouchDB in rails.
8 stars 3 forks source link

Better documentation #86

Open seancookr opened 9 years ago

seancookr commented 9 years ago

@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

rubenrails commented 9 years ago

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.