Skip to content

Commit 5d28be7

Browse files
authored
Merge pull request #27 from marklogic/feature/error-handling-docs-tweak
More detail on error handling in the docs
2 parents 52bec3f + b25e4f9 commit 5d28be7

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

docs/managing-documents/reading.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,8 @@ for more information on reading documents.
119119
If the `client.documents.read` method receives an HTTP response with a status code of 200, then the client will return
120120
a list of `Document` instances. For any other status code, the client will return the `requests` `Response` object,
121121
providing access to the error details returned by the MarkLogic REST API.
122+
123+
The `status_code` and `text` fields in the `Response` object will typically be of the most interest when
124+
debugging a problem. Please see
125+
[Response API documentation](https://docs.python-requests.org/en/latest/api/#requests.Response) for complete information on what's available in this object.
126+

docs/managing-documents/searching.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,7 @@ for more information on searching documents.
160160
If the `client.documents.read` method receives an HTTP response with a status code of 200, then the client will return
161161
a list of `Document` instances. For any other status code, the client will return the `requests` `Response` object,
162162
providing access to the error details returned by the MarkLogic REST API.
163+
164+
The `status_code` and `text` fields in the `Response` object will typically be of the most interest when
165+
debugging a problem. Please see
166+
[Response API documentation](https://docs.python-requests.org/en/latest/api/#requests.Response) for complete information on what's available in this object.

docs/managing-documents/writing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,3 +156,7 @@ Because the `client.documents.write` method returns a `requests Response` object
156156
processing of the request will be captured within that `Response` object. The client does not attempt to provide any
157157
additional information, as the MarkLogic REST API will already provide details within the response body and potentially
158158
the response headers as well.
159+
160+
The `status_code` and `text` fields in the `Response` object will typically be of the most interest when
161+
debugging a problem. Please see
162+
[Response API documentation](https://docs.python-requests.org/en/latest/api/#requests.Response) for complete information on what's available in this object.

0 commit comments

Comments
 (0)