diff options
Diffstat (limited to 'doc/manual.html')
| -rw-r--r-- | doc/manual.html | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/manual.html b/doc/manual.html index 1b17e75..b643e7b 100644 --- a/doc/manual.html +++ b/doc/manual.html @@ -104,6 +104,20 @@ cryptography. The concatenation of header, dot, payload, dot and signature in base64 is the encoding of the JWT. </p> + <h1>What if something goes wrong?</h1> + <p> + The library will raise an exception whenever something fishy + occurs. For instance, if a signature is invalid, or the + expiration date has passed. All exception types are defined in + <emph>(webid-oidc errors)</emph>. + </p> + <info:deffn type="function" name="error->str" arguments="error [#depth]"> + <p> + Return a string explaining the <info:var>error</info:var>. You + can limit the <info:var>depth</info:var> of the explanation as + an integer. + </p> + </info:deffn> <h1 type="appendix">GNU Free Documentation License</h1> <info:gfdl /> |