From da389927ddf9240bbba10b819eb782e80a5d6bf7 Mon Sep 17 00:00:00 2001 From: Jed Barber <jjbarber@y7mail.com> Date: Tue, 19 Jan 2021 02:25:44 +1100 Subject: Basic HTML documentation added --- doc/errors.html | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 doc/errors.html (limited to 'doc/errors.html') diff --git a/doc/errors.html b/doc/errors.html new file mode 100644 index 0000000..e0f12c0 --- /dev/null +++ b/doc/errors.html @@ -0,0 +1,33 @@ + +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Handling Errors - Packrat Docs</title> + <link href="default.css" rel="stylesheet"> + </head> + + <body> + + + <h2>Handling Errors</h2> + + <a href="index.html">Return to Contents</a> + + + <p>Whenever a <em>Lexer_Error</em> or <em>Parser_Error</em> is raised it is always accompanied + with a string that contains encoded information about where in the input the error occurred.</p> + + <p>Such strings should not be examined directly, but if the <em>Decode</em> function from + <em>Packrat.Errors</em> is used then an array of symbol/position pairs is obtained. Each of those + pairs describes a point in the input where, if the given symbol was successfully found, a more + successful parse would have resulted.</p> + + <p>Unfortunately at this time no resumption of lexing or parsing can be done once an error has + occurred.</p> + + + </body> +</html> + -- cgit