couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject documentation commit: updated refs/heads/master to 2008f90
Date Mon, 03 Aug 2015 21:48:45 GMT
Repository: couchdb-documentation
Updated Branches:
  refs/heads/master b7efaa3f7 -> 2008f90ef

note link between startkey and startkey_docid

The fact that startkey_docid depends upon startkey isn't explicitly mentioned, and has caused
confusion in issues like


Branch: refs/heads/master
Commit: 2008f90ef8895aaf010310f4759630733ae2479b
Parents: b7efaa3
Author: Sean Lang <>
Authored: Mon Aug 3 17:27:59 2015 -0400
Committer: Sean Lang <>
Committed: Mon Aug 3 17:27:59 2015 -0400

 src/api/ddoc/views.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/src/api/ddoc/views.rst b/src/api/ddoc/views.rst
index c81f2b0..5cda00c 100644
--- a/src/api/ddoc/views.rst
+++ b/src/api/ddoc/views.rst
@@ -36,7 +36,8 @@
       reached. *Optional*
     :query json end_key: Alias for `endkey` param
     :query string endkey_docid: Stop returning records when the specified
-      document ID is reached. *Optional*
+      document ID is reached. Requires ``endkey`` to be specified for this to
+      have any effect. *Optional*
     :query string end_key_doc_id: Alias for `endkey_docid` param
     :query boolean group: Group the results using the reduce function to a
       group or single row. Default is ``false``
@@ -68,7 +69,8 @@
     :query json start_key: Alias for `startkey` param
     :query string startkey_docid: Return records starting with the specified
-      document ID. *Optional*
+      document ID. Requires ``startkey`` to be specified for this to have any
+      effect. *Optional*
     :query string start_key_doc_id: Alias for `startkey_docid` param
     :query boolean update_seq: Response includes an ``update_seq`` value
       indicating which sequence id of the database the view reflects.

View raw message