Merge pull request #19 from marklogic/feature/more-doc-fixes

Few more docs fixes

Author: rjrudin

docs/creating-client.md

@@ -35,7 +35,7 @@ response = client.post('/v1/search')
 response = client.get('/v1/documents', params={'uri': '/my-doc.json'})
 ```
 
-Because the `Client` class extends the `Sessions` class, it can be used as a context manager:
+Because the `Client` class extends the `Session` class, it can be used as a context manager:
 
 ```
 with Client('http://localhost:8000', digest=('python-user', 'pyth0n')) as client:

docs/managing-documents/reading.md

@@ -89,8 +89,19 @@ docs = client.documents.read(uris, categories=["collections"])
 print(docs)
 ```
 
-# Error handling
+## Providing additional arguments
 
-A GET call to the /v1/documents endpoint in MarkLogic will return an HTTP response with a status code of 200 for a
-successful request. For any other status code, the `client.documents.read` method will the `requests` `Response` object,
-providing access to the error details returned by MarkLogic.
+The `client.documents.read` method provides a `**kwargs` argument, so you can pass in any other arguments you would
+normally pass to `requests`. For example:
+
+```
+uris = ["/doc1.json", "/doc2.xml", "/doc3.bin"]
+docs = client.documents.read(uris, params={"database": "Documents"})
+assert len(docs) == 2
+```
+
+## Error handling
+
+If the `client.documents.read` method receives an HTTP response with a status code of 200, then the client will return
+a list of `Document` instances. For any other status code, the client will return the `requests` `Response` object, 
+providing access to the error details returned by the MarkLogic REST API.

docs/managing-documents/searching.md

@@ -8,7 +8,7 @@ permalink: /documents/searching
 
 The [POST /v1/search endpoint](https://docs.marklogic.com/REST/POST/v1/search) in the MarkLogic REST API supports
 returning content and metadata for each matching document. Similar to reading multiple documents via the 
-[GET /v1/documents endpoint](https://docs.marklogic.com/REST/GET/v1/documents, the data is returned in a multipart
+[GET /v1/documents endpoint](https://docs.marklogic.com/REST/GET/v1/documents), the data is returned in a multipart
 HTTP response. The MarkLogic Python client simplifies use of this operation by returning a list of `Document` instances
 via the `client.documents.search` method.
 
@@ -139,9 +139,10 @@ assert docs[0].content is None
 assert docs[1].content is None
 ```
 
-The `client.documents.search` method provides a `**kwargs` argument, so you can pass in any other arguments you would
-normally pass to `requests`, such as a `params` argument that specifies additional parameters:
+## Providing additional arguments
 
+The `client.documents.search` method provides a `**kwargs` argument, so you can pass in any other arguments you would
+normally pass to `requests`. For example:
 
 ```
 docs = client.documents.search("example", params={"database": "Documents"})
@@ -150,6 +151,6 @@ assert len(docs) == 2
 
 ## Error handling
 
-A POST call to the /v1/search endpoint in MarkLogic will return an HTTP response with a status code of 200 for a
-successful request. For any other status code, the `client.documents.search` method will the `requests` `Response` object,
-providing access to the error details returned by MarkLogic.
+If the `client.documents.read` method receives an HTTP response with a status code of 200, then the client will return
+a list of `Document` instances. For any other status code, the client will return the `requests` `Response` object, 
+providing access to the error details returned by the MarkLogic REST API.

docs/managing-documents/writing.md

@@ -138,6 +138,15 @@ construct the URI:
 client.documents.write([Document(None, {"doc": 1}, extension=".json", directory="/example/")])
 ```
 
+## Providing additional arguments
+
+The `client.documents.write` method provides a `**kwargs` argument, so you can pass in any other arguments you would
+normally pass to `requests`. For example:
+
+```
+response = client.documents.write(Document("/doc1.json", {"doc": 1}, permissions=default_perms), params={"database": "Documents"})
+```
+
 ## Error handling
 
 Because the `client.documents.write` method returns a `requests Response` object, any error that occurs during