Add docs for .errmsg().

866f7d40 · Geoff Simmons · c690f5f6 · 866f7d40 · 866f7d40
Commit 866f7d40 authored Sep 22, 2019 by Geoff Simmons
Hide whitespace changes
Inline Side-by-side

Showing with 16 additions and 2 deletions

README.rst README.rst +8 -1

vmod_file.vcc src/vmod_file.vcc +8 -1

No files found.
--- a/README.rst
+++ b/README.rst
@@ -295,7 +295,14 @@ Return the error message for any error condition determined the last
 time the file was checked, or a message indicating that there was no
 error.

-XXX ...
+Example::
+
+  import std;
+
+  if (rdr.error()) {
+	std.log("rdr error: " + rdr.errmsg());
+	call do_file_error_handling;
+  }

 .. _xreader.size():


--- a/src/vmod_file.vcc
+++ b/src/vmod_file.vcc
@@ -269,7 +269,14 @@ Return the error message for any error condition determined the last
 time the file was checked, or a message indicating that there was no
 error.

-XXX ...
+Example::
+
+  import std;
+
+  if (rdr.error()) {
+	std.log("rdr error: " + rdr.errmsg());
+	call do_file_error_handling;
+  }

 $Method BYTES .size()