couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andyw...@apache.org
Subject couchdb commit: updated refs/heads/documentation-fixes to b38f100
Date Thu, 23 Jan 2014 23:21:44 GMT
Updated Branches:
  refs/heads/documentation-fixes [created] b38f1007b


added documentation fixes

made the deletion of a document clearer and
fixed some wording in the JSON structure tables


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/b38f1007
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/b38f1007
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/b38f1007

Branch: refs/heads/documentation-fixes
Commit: b38f1007be3609ae25003bfb310d5a96db77ea06
Parents: 37c8459
Author: Andy Wenk <andywenk@apache.org>
Authored: Fri Jan 24 00:20:41 2014 +0100
Committer: Andy Wenk <andywenk@apache.org>
Committed: Fri Jan 24 00:20:41 2014 +0100

----------------------------------------------------------------------
 share/doc/src/api/document/common.rst | 11 ++++++++---
 share/doc/src/json-structure.rst      | 20 ++++++++++----------
 2 files changed, 18 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/b38f1007/share/doc/src/api/document/common.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/document/common.rst b/share/doc/src/api/document/common.rst
index f21c8df..f6e4b2a 100644
--- a/share/doc/src/api/document/common.rst
+++ b/share/doc/src/api/document/common.rst
@@ -242,9 +242,14 @@
 .. http:delete:: /{db}/{docid}
   :synopsis: Deletes the document
 
-  Deletes the specified document from the database. You must supply the
-  current (latest) revision, either by using the ``rev`` parameter to
-  specify the revision.
+  Marks the specified document as deleted by adding a field _deleted with
+  the value true. Documents with this field will not be returned within
+  requests anymore, but stay in the database. You must supply the current
+  (latest) revision, either by using the ``rev`` parameter or by using the
+  ``If-Match`` header to specify the revision.
+
+  .. seealso::
+    :ref:`Retrieving Deleted Documents <api/doc/retrieving-deleted-documents>`
 
   .. note::
     Note that deletion of a record increments the revision number.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/b38f1007/share/doc/src/json-structure.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/json-structure.rst b/share/doc/src/json-structure.rst
index 7d22f1e..0a6de0d 100644
--- a/share/doc/src/json-structure.rst
+++ b/share/doc/src/json-structure.rst
@@ -119,30 +119,30 @@ CouchDB database information object
 +================================+=============================================+
 | db_name                        | The name of the database.                   |
 +--------------------------------+---------------------------------------------+
-| committed_update_seq           | The number of committed update.             |
+| committed_update_seq           | The number of committed updates.            |
 +--------------------------------+---------------------------------------------+
-| doc_count                      | A count of the documents in the specified   |
-|                                | database.                                   |
+| doc_count                      | The number of documents in the database.    |
 +--------------------------------+---------------------------------------------+
-| doc_del_count                  | Number of deleted documents                 |
+| doc_del_count                  | The number of deleted documents.            |
 +--------------------------------+---------------------------------------------+
 | compact_running                | Set to true if the database compaction      |
 |                                | routine is operating on this database.      |
 +--------------------------------+---------------------------------------------+
 | disk_format_version            | The version of the physical format used for |
-|                                | the data when it is stored on disk.         |
+|                                | the data when it is stored on hard disk.    |
 +--------------------------------+---------------------------------------------+
-| disk_size                      | Size in bytes of the data as stored on the  |
-|                                | disk. Views indexes are not included in the |
+| disk_size                      | Size in bytes of the data as stored on disk.|
+|                                | Views indexes are not included in the       |
 |                                | calculation.                                |
 +--------------------------------+---------------------------------------------+
-| instance_start_time            | Timestamp of when the database was opened,  |
-|                                | expressed in microseconds since the epoch.  |
+| instance_start_time            | Timestamp indicating when the database was  |
+|                                | opened, expressed in microseconds since the |
+|                                | epoch.                                      |
 +--------------------------------+---------------------------------------------+
 | purge_seq                      | The number of purge operations on the       |
 |                                | database.                                   |
 +--------------------------------+---------------------------------------------+
-| update_seq                     | The current number of updates to the        |
+| update_seq                     | The current number of updates made in the   |
 |                                | database.                                   |
 +--------------------------------+---------------------------------------------+
 


Mime
View raw message