[GitHub] couchdb-nano issue #17: Documentation needs fixed for passing keys as parame...

[carlosduclos <gi...@git.apache.org>]

GitHub user carlosduclos opened an issue:

    https://github.com/apache/couchdb-nano/issues/17

    Documentation needs fixed for passing keys as parameter in db.view

    [Original issue](https://github.com/dscape/nano/issues/304)
    
    __PaulAllan1__
    Currently the documentation for db.view is as follows:
    "db.view(designname, viewname, [params], [callback])
    
    calls a view of the specified design with optional query string additions params. if you're looking to filter the view results by key(s) pass an array of keys, e.g { keys: ['key1', 'key2', 'key_n'] }, as params."
    
    In actual fact what needs to be passed in to filter by keys is more like {keys: [['key1', 'key2', 'key_n']] }. Please update the documentation.
    
    __franklinlindemberg__
    I agree with @PaulAllan1, please update the documentation. I lost much time trying to figure it out.
    Regards.

----

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---