{"action":"created","issue":{"url":"https://api.github.com/repos/pouchdb/pouchdb/issues/4346","labels_url":"https://api.github.com/repos/pouchdb/pouchdb/issues/4346/labels{/name}","comments_url":"https://api.github.com/repos/pouchdb/pouchdb/issues/4346/comments","events_url":"https://api.github.com/repos/pouchdb/pouchdb/issues/4346/events","html_url":"https://github.com/pouchdb/pouchdb/issues/4346","id":106902230,"number":4346,"title":"Deprecate returnDocs in favor of return_docs","user":{"login":"nolanlawson","id":283842,"avatar_url":"https://avatars.githubusercontent.com/u/283842?v=3","gravatar_id":"","url":"https://api.github.com/users/nolanlawson","html_url":"https://github.com/nolanlawson","followers_url":"https://api.github.com/users/nolanlawson/followers","following_url":"https://api.github.com/users/nolanlawson/following{/other_user}","gists_url":"https://api.github.com/users/nolanlawson/gists{/gist_id}","starred_url":"https://api.github.com/users/nolanlawson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nolanlawson/subscriptions","organizations_url":"https://api.github.com/users/nolanlawson/orgs","repos_url":"https://api.github.com/users/nolanlawson/repos","events_url":"https://api.github.com/users/nolanlawson/events{/privacy}","received_events_url":"https://api.github.com/users/nolanlawson/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/pouchdb/pouchdb/labels/enhancement","name":"enhancement","color":"02d7e1"},{"url":"https://api.github.com/repos/pouchdb/pouchdb/labels/first%20timers%20only","name":"first timers only","color":"02e10c"},{"url":"https://api.github.com/repos/pouchdb/pouchdb/labels/help%20wanted","name":"help wanted","color":"02e10c"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-09-17T02:50:29Z","updated_at":"2015-09-18T19:37:04Z","closed_at":null,"body":"Ala https://github.com/pouchdb/pouchdb/pull/4338, I would like us to be consistent about our naming conventions for options. `camel_case` is what we use almost everywhere (because it fits the CouchDB conventions), but there are odd exceptions, the last of which (I believe) being `returnDocs` (see [changes()](http://pouchdb.com/api.html#changes)). \r\n\r\nI think we should support both `returnDocs` and `return_docs` but mark `returnDocs` for deprecation in the docs."},"comment":{"url":"https://api.github.com/repos/pouchdb/pouchdb/issues/comments/141547826","html_url":"https://github.com/pouchdb/pouchdb/issues/4346#issuecomment-141547826","issue_url":"https://api.github.com/repos/pouchdb/pouchdb/issues/4346","id":141547826,"user":{"login":"nolanlawson","id":283842,"avatar_url":"https://avatars.githubusercontent.com/u/283842?v=3","gravatar_id":"","url":"https://api.github.com/users/nolanlawson","html_url":"https://github.com/nolanlawson","followers_url":"https://api.github.com/users/nolanlawson/followers","following_url":"https://api.github.com/users/nolanlawson/following{/other_user}","gists_url":"https://api.github.com/users/nolanlawson/gists{/gist_id}","starred_url":"https://api.github.com/users/nolanlawson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nolanlawson/subscriptions","organizations_url":"https://api.github.com/users/nolanlawson/orgs","repos_url":"https://api.github.com/users/nolanlawson/repos","events_url":"https://api.github.com/users/nolanlawson/events{/privacy}","received_events_url":"https://api.github.com/users/nolanlawson/received_events","type":"User","site_admin":false},"created_at":"2015-09-18T19:37:04Z","updated_at":"2015-09-18T19:37:04Z","body":"By the way the deprecation notice should go in [api.html](http://pouchdb.com/api.html), which can be modified [here](https://github.com/pouchdb/pouchdb/edit/master/docs/_includes/api/overview.html). Just find the part about `returnDocs` and add a note that it's now `return_docs`."}}