couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject git commit: updated refs/heads/master to 1944276
Date Fri, 11 Oct 2013 10:52:25 GMT
Updated Branches:
  refs/heads/master 5a10e8246 -> 1944276fe


Fixed `method` terminology usage w/database

The basics.rst includes an explanation of how
an HTTP API works (leveraging HTTP methods
rather than inventing new ones), but the API
reference docs misuse the term thereafter.


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

Branch: refs/heads/master
Commit: 1944276fe350e57d111a065d658c3d403bcf4e12
Parents: 5a10e82
Author: BigBlueHat <byoung@bigbluehat.com>
Authored: Fri Oct 11 14:51:54 2013 +0400
Committer: Alexander Shorin <kxepal@apache.org>
Committed: Fri Oct 11 14:51:54 2013 +0400

----------------------------------------------------------------------
 share/doc/src/api/database/bulk-api.rst |  4 ++--
 share/doc/src/api/database/changes.rst  |  8 ++++----
 share/doc/src/api/database/common.rst   |  5 +++--
 share/doc/src/api/database/index.rst    | 12 ++++++------
 share/doc/src/api/ddoc/index.rst        |  6 +++---
 share/doc/src/api/ddoc/rewrites.rst     | 12 ++++++------
 share/doc/src/api/ddoc/views.rst        |  4 ++--
 share/doc/src/api/document/common.rst   |  2 +-
 share/doc/src/api/document/index.rst    |  9 ++++-----
 share/doc/src/api/local.rst             |  6 +++---
 share/doc/src/api/server/authn.rst      |  9 ++++-----
 11 files changed, 38 insertions(+), 39 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/database/bulk-api.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/database/bulk-api.rst b/share/doc/src/api/database/bulk-api.rst
index 1c88fbf..2e3919a 100644
--- a/share/doc/src/api/database/bulk-api.rst
+++ b/share/doc/src/api/database/bulk-api.rst
@@ -295,8 +295,8 @@ database. The constraints are detailed in :ref:`api/db/bulk_docs/semantics`.
 
 To insert documents in bulk into a database you need to supply a JSON
 structure with the array of documents that you want to add to the
-database. Using this method you can either include a document ID, or
-allow the document ID to be automatically generated.
+database. You can either include a document ID, or allow the document ID to be
+automatically generated.
 
 For example, the following update inserts three new documents, two with the
 supplied document IDs, and one which will have a document ID generated:

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/database/changes.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/database/changes.rst b/share/doc/src/api/database/changes.rst
index db6af63..c414c67 100644
--- a/share/doc/src/api/database/changes.rst
+++ b/share/doc/src/api/database/changes.rst
@@ -39,8 +39,8 @@
     previous connection. Overrides `since` query parameter.
   :query array doc_ids: List of document IDs to filter the changes feed as
    valid JSON array. Used with :ref:`_doc_ids <changes/filter/doc_ids>` filter.
-   Since `length of URL is limited`_, you better use :post:`/{db}/_changes`
-   method instead.
+   Since `length of URL is limited`_, it is better to use
+   :post:`/{db}/_changes` instead.
   :query boolean conflicts: Includes `conflicts` information in response.
     Ignored if `include_docs` isn't ``true``. Default is ``false``.
   :query boolean descending: Return the change results in descending sequence
@@ -165,8 +165,8 @@
 .. http:post:: /{db}/_changes
 
   Requests the database changes feed in the same way as
-  :get:`/{db}/_changes` does, but this method is widely used with
-  ``?filter=_doc_ids`` query parameter and allows to pass larger list of
+  :get:`/{db}/_changes` does, but is widely used with
+  ``?filter=_doc_ids`` query parameter and allows one to pass a larger list of
   document IDs to filter.
 
   **Request**:

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/database/common.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/database/common.rst b/share/doc/src/api/database/common.rst
index 4d4d24c..e3e3657 100644
--- a/share/doc/src/api/database/common.rst
+++ b/share/doc/src/api/database/common.rst
@@ -18,8 +18,9 @@
 .. http:head:: /{db}
 
   Returns the HTTP Headers containing a minimal amount of information
-  about the specified database. Since the response body is empty this method
-  is a lightweight way to check if the database exists already or not.
+  about the specified database. Since the response body is empty, using the
+  HEAD method is a lightweight way to check if the database exists already or
+  not.
 
   :param db: Database name
   :code 200: Database exists

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/database/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/database/index.rst b/share/doc/src/api/database/index.rst
index 2441fd4..5da6a32 100644
--- a/share/doc/src/api/database/index.rst
+++ b/share/doc/src/api/database/index.rst
@@ -12,14 +12,14 @@
 
 .. _api/database:
 
-================
-Database Methods
-================
+=========
+Databases
+=========
 
-The Database methods provide an interface to an entire database withing
-CouchDB. These are database, rather than document, level requests.
+The Database endpoint provides an interface to an entire database with in
+CouchDB. These are database-level, rather than document-level requests.
 
-For all the database methods, the database name within the URL path
+For all these requests, the database name within the URL path
 should be the database name that you wish to perform the operation on.
 For example, to obtain the meta information for the database
 ``recipes``, you would use the HTTP request:

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/ddoc/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/ddoc/index.rst b/share/doc/src/api/ddoc/index.rst
index 12b9007..20e6740 100644
--- a/share/doc/src/api/ddoc/index.rst
+++ b/share/doc/src/api/ddoc/index.rst
@@ -13,9 +13,9 @@
 
 .. _api/design-docs:
 
-=======================
-Design Document Methods
-=======================
+================
+Design Documents
+================
 
 In CouchDB, design documents provide the main interface for building a
 CouchDB application. The design document defines the views used to

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/ddoc/rewrites.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/ddoc/rewrites.rst b/share/doc/src/api/ddoc/rewrites.rst
index d6e83a9..4e9a9b5 100644
--- a/share/doc/src/api/ddoc/rewrites.rst
+++ b/share/doc/src/api/ddoc/rewrites.rst
@@ -28,8 +28,8 @@
   - **to** (*string*): Rule to rewrite an url. It can contain variables
     depending on  binding variables discovered during pattern matching and
     query args (url args and from the query member)
-  - **method** (*string*): Method to bind the request method to the rule.
-    Default is ``"*"``
+  - **method** (*string*): HTTP request method to bind the request method to
+    the rule. Default is ``"*"``
   - **query** (*object*): Query args you want to define they can contain
     dynamic variable by binding the key
 
@@ -49,10 +49,10 @@
   - If all tokens are matched and all `pathterms` are used, then the `pathspec`
     matches
 
-  The pattern matching is done by first matching the request method to a rule.
-  By default all methods match a rule. (method is equal to ``"*"`` by default).
-  Then It will try to match the path to one rule. If no rule match, then a
-  :statuscode:`404` response returned.
+  The pattern matching is done by first matching the HTTP request method to a
+  rule. ``method`` is equal to ``"*"`` by default, and will match any HTTP
+  method. It will then try to match the path to one rule. If no rule matches,
+  then a :statuscode:`404` response returned.
 
   Once a rule is found we rewrite the request url using the ``to`` and ``query``
   fields. The identified token are matched to the rule and will replace var.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/ddoc/views.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/ddoc/views.rst b/share/doc/src/api/ddoc/views.rst
index 8683085..a456dab 100644
--- a/share/doc/src/api/ddoc/views.rst
+++ b/share/doc/src/api/ddoc/views.rst
@@ -126,8 +126,8 @@
 .. http:post:: /{db}/_design/{ddoc}/_view/{view}
 
   Executes the specified view function from the specified design document.
-  Unlike the :get:`/{db}/_design/{ddoc}/_view/{view}`  method
-  for accessing views, the :method:`POST` method supports the specification
+  Unlike :get:`/{db}/_design/{ddoc}/_view/{view}` for accessing views, the
+  :method:`POST` method supports the specification
   of explicit keys to be retrieved from the view results. The remainder of the
   :method:`POST` view functionality is identical to the
   :get:`/{db}/_design/{ddoc}/_view/{view}` API.

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/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 49ffe42..762bfb9 100644
--- a/share/doc/src/api/document/common.rst
+++ b/share/doc/src/api/document/common.rst
@@ -167,7 +167,7 @@
 .. http:put:: /{db}/{docid}
 
   The :method:`PUT` method creates a new named document, or creates a new
-  revision of the existing document. Unlike the :post:`/{db}` method, you
+  revision of the existing document. Unlike the :post:`/{db}`, you
   must specify the document ID in the request URL.
 
   :param db: Database name

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/document/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/document/index.rst b/share/doc/src/api/document/index.rst
index 8c0460c..8e6b135 100644
--- a/share/doc/src/api/document/index.rst
+++ b/share/doc/src/api/document/index.rst
@@ -13,12 +13,11 @@
 
 .. _api/document:
 
-================
-Document Methods
-================
+=========
+Documents
+=========
 
-The CouchDB API Server Document methods detail how to create, read,
-update and delete documents within a database.
+Details on how to create, read, update and delete documents within a database.
 
 .. toctree::
 

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/local.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/local.rst b/share/doc/src/api/local.rst
index 970523e..c91c96b 100644
--- a/share/doc/src/api/local.rst
+++ b/share/doc/src/api/local.rst
@@ -12,9 +12,9 @@
 
 .. _api/local:
 
-========================================
-Local (non-replicating) Document Methods
-========================================
+=================================
+Local (non-replicating) Documents
+=================================
 
 The Local (non-replicating) document interface allows you to create
 local documents that are not replicated to other databases. These

http://git-wip-us.apache.org/repos/asf/couchdb/blob/1944276f/share/doc/src/api/server/authn.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/server/authn.rst b/share/doc/src/api/server/authn.rst
index a3ac3ea..27b1dc6 100644
--- a/share/doc/src/api/server/authn.rst
+++ b/share/doc/src/api/server/authn.rst
@@ -12,12 +12,11 @@
 
 .. _api/auth:
 
-======================
-Authentication Methods
-======================
+==============
+Authentication
+==============
 
-The CouchDB Authentication methods provide an interface for obtaining
-session and authorization data.
+Interfaces for obtaining session and authorization data.
 
 .. note:: We're also strongly recommend you to
    :ref:`setup SSL <config/ssl>` to improve all authentication methods security.


Mime
View raw message