Documentation

This commit is contained in:
richardpaulhudson 2023-01-26 20:41:52 +01:00
parent ea935a24e3
commit bd46e849dd

View File

@ -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
>