From bd46e849dd6b11a723848620e407fc44c85c9b31 Mon Sep 17 00:00:00 2001 From: richardpaulhudson Date: Thu, 26 Jan 2023 20:41:52 +0100 Subject: [PATCH] Documentation --- website/docs/api/doc.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/website/docs/api/doc.mdx b/website/docs/api/doc.mdx index b891c0c48..fa6eba841 100644 --- a/website/docs/api/doc.mdx +++ b/website/docs/api/doc.mdx @@ -523,9 +523,11 @@ JSON data as generated by [`Doc.to_json()`](/api/doc#to_json). ## Doc.inspect {id="inspect",tag="method",version="4"} Outputs to the console a human-readable, tabular representation of all or part -of the document. If any of the four optional parameters are specified, those -sentences in the document that correspond to the specification are displayed; if -none of them are specified, the whole document is displayed. +of the document. If any of the first three optional parameters are specified, +the first sentence in the document that corresponds to the specification is +displayed, although a larger portion can be specified with the `length` +parameter; if none of the optional parameters is specified, the whole document +is displayed. > #### Example >