From 1803c85621826d9efcc23220c0053afeb36d791d Mon Sep 17 00:00:00 2001
From: Charles Daniels <charles@cdaniels.net>
Date: Thu, 29 Jul 2021 23:06:29 -0400
Subject: [PATCH] fix up some documentation

---
 logquery.go      |  6 +++---
 parser/parser.go | 17 ++++-------------
 2 files changed, 7 insertions(+), 16 deletions(-)

diff --git a/logquery.go b/logquery.go
index 604de01..cb9d824 100644
--- a/logquery.go
+++ b/logquery.go
@@ -192,9 +192,9 @@ func backgroundParser(stream io.Reader, out chan interface{}, quit chan int) {
 	}
 }
 
-// RunQuery executse the specified query on the logfmt data provided on the
-// given stream input, writing any results to the given output stream using the
-// specified format.
+// RunQuery executes the specified SQLite query on the logfmt data provided on
+// the given stream input, writing any results to the given output stream using
+// the specified format.
 func RunQuery(stream io.Reader, output io.Writer, query string, format OutputFormat) error {
 
 	db, err := sqlite3.Open(":memory:")
diff --git a/parser/parser.go b/parser/parser.go
index 64f39bc..de53ddb 100644
--- a/parser/parser.go
+++ b/parser/parser.go
@@ -18,19 +18,10 @@
 // (") quotes are acceptable for quoted strings. Within quoted strings, the
 // following escape characters are recognized:
 //
-// * \a
-// * \b
-// * \\
-// * \t
-// * \n
-// * \f
-// * \r
-// * \v
-// * \'
-// * \"
-// * \xhh
-//    * Interpreted to mean the hex value hh, cast to a Go rune. Exactly two
-//      hex digits are required.
+// \a, \b, \\, \t, \n, \f, \r, \v, \', \", \xhh
+//
+// \xhh is interpreted to mean the hex value hh, cast to a Go rune. Exactly two
+// hex digits are required.
 //
 // Unquoted values contain any non-whitespace, non-newline character except for
 // '=', keys have the same constraint, but also cannot contain ;, ' or "
-- 
2.45.2