small docs change/fixes

docs/available_storages.rst

@@ -96,7 +96,7 @@ Descriptions:
   // Digest authentication is not implemented
 
 **Be careful**: The generated description never contains a readable password, but
-for basic authentication, the password will just be base64 encoded.
+for basic authentication, the password is just base64 encoded.
 
 S3Storage
 ^^^^^^^^^

docs/getting_started.rst

@@ -21,7 +21,7 @@ Getting started
       <script ...>
 
 
-    With `RequireJS <http://requirejs.org/>`_, the main.js will look like:
+    With `RequireJS <http://requirejs.org/>`_, the main.js should look like:
 
     .. code-block:: javascript
 

docs/keys.rst

@@ -244,12 +244,12 @@ A key_schema object can have three properties:
 
 * ``key_set`` - required.
 
-* ``cast_lookup`` - optional, a mapping of name: function that will
-  be used if cast_to is a string. If cast_lookup is not provided,
+* ``cast_lookup`` - optional, an object of the form ``{name: function}`` that is
+  used if cast_to is a string. If cast_lookup is not provided,
   then cast_to must be a function.
 
-* ``match_lookup`` - optional, a mapping of name: function that will
-  be used if ``equal_match`` is a string. If match_lookup is not provided,
+* ``match_lookup`` - optional, an object of the form ``{name: function}`` that is
+  used if ``equal_match`` is a string. If match_lookup is not provided,
   then ``equal_match`` must be a function.
 
 

docs/manage_documents.rst

@@ -124,7 +124,7 @@ see how method calls should be made with either of these storages.
 Promises
 --------
 
-Each jIO method returns a Promise object, which allows us to get responses into
+Each jIO method (with the exception of ``.createJIO()``) returns a Promise object, which allows us to get responses into
 callback parameters and to chain callbacks with other returned values.
 
 jIO uses a custom version of `RSVP.js <https://github.com/tildeio/rsvp.js>`_, adding canceler and progression features.
@@ -157,7 +157,7 @@ Here is a list of responses returned by jIO according to methods and options:
 ==================   ==============================================   ===============================================
  Option              Available for                                    Response (Callback first parameter)
 ==================   ==============================================   ===============================================
-No options           ``.post()``, ``.put()``, ``.remove()``           .. code-block:: javascript
+Any                  ``.post()``, ``.put()``, ``.remove()``           .. code-block:: javascript
  
                                                                        {
                                                                          result: 'success',
@@ -167,7 +167,7 @@ No options           ``.post()``, ``.put()``, ``.remove()``           .. code-bl
                                                                          status: 204,
                                                                          statusText: 'No Content'
                                                                        }
-No options           ``.putAttachment()``, ``.removeAttachment()``    .. code-block:: javascript
+Any                  ``.putAttachment()``, ``.removeAttachment()``    .. code-block:: javascript
 
                                                                        {
                                                                          result: 'success',
@@ -178,7 +178,7 @@ No options           ``.putAttachment()``, ``.removeAttachment()``    .. code-bl
                                                                          status: 204,
                                                                          statusText: 'No Content'
                                                                        }
-No options           ``.get()``                                       .. code-block:: javascript
+Any                  ``.get()``                                       .. code-block:: javascript
 
                                                                        {
                                                                          result: 'success',
@@ -190,7 +190,7 @@ No options           ``.get()``                                       .. code-bl
                                                                            // Here, the document metadata
                                                                          }
                                                                        }
-No options           ``.getAttachment()``                             .. code-block:: javascript
+Any                  ``.getAttachment()``                             .. code-block:: javascript
 
                                                                        {
                                                                          result: 'success',
@@ -243,7 +243,7 @@ include_docs: true   ``.allDocs()``                                   .. code-bl
 
 
 
-In case of error, the ``errorCallback`` first parameter will look like:
+In case of error, the ``errorCallback`` first parameter looks like:
 
 .. code-block:: javascript
 

docs/metadata.rst

@@ -93,7 +93,7 @@ Identification
   | ``{"date": {"scheme": "DCTERMS.W3CDTF", "content": "2011-12-13"}}``
 
   A date associated with an event in the life cycle of the resource. Typically,
-  Date will be associated with the creation or availability of the resource.
+  Date is associated with the creation or availability of the resource.
   Recommended best practice for encoding the date value is defined in a profile
   of ISO 8601 `Date and Time Formats, W3C Note <http://www.w3.org/TR/NOTE-datetime>`_
   and follows the YYYY-MM-DD format.
@@ -107,7 +107,7 @@ Identification
   The nature or genre of the content of the resource. Type includes terms describing
   general categories, functions, genres, or aggregation levels for content.
   Recommended best practice is to select a value from a controlled vocabulary.
-  **The type is not a MIME Type!**
+  **This type is not a MIME Type!**
 
 
 Intellectual property
@@ -145,7 +145,7 @@ Intellectual property
   | ``{"rights": "https://www.j-io.org/documentation/jio-documentation/#copyright-and-license"}``
 
   Information about rights held in and over the resource. Typically a Rights
-  element will contain a rights management statement for the resource, or
+  element should contain a rights management statement for the resource, or
   reference a service providing such information. Rights information often
   encompasses Intellectual Property Rights (IPR), Copyright, and various Property
   Rights. If the rights element is absent, no assumptions can be made about the
@@ -159,14 +159,14 @@ Content
 
   | ``{"title": "jIO Home Page"}``
 
-  The name given to the resource. Typically, a Title will be a name by which the resource is formally known.
+  The name given to the resource. Typically, a Title is a name by which the resource is formally known.
 
 * **subject**
 
   | ``{"subject": "jIO"}``
   | ``{"subject": ["jIO", "basics"]}``
 
-  The topic of the content of the resource. Typically, a Subject will be
+  The topic of the content of the resource. Typically, a Subject is
   expressed as keywords or key phrases or classification codes that describe the
   topic of the resource. Recommended best practice is to select a value from a
   controlled vocabulary or formal classification scheme.
@@ -212,7 +212,7 @@ Content
 
   | ``{"coverage": "France"}``
 
-  The extent or scope of the content of the resource. Coverage will typically
+  The extent or scope of the content of the resource. Coverage would typically
   include spatial location (a place name or geographic co-ordinates), temporal
   period (a period label, date, or date range) or jurisdiction (such as a named
   administrative entity). Recommended best practice is to select a value from a