From 7ea97cd45172328f4a05694f995fe073e3ddd295 Mon Sep 17 00:00:00 2001 From: Jacob Daniel Bennett Date: Fri, 16 Oct 2020 11:03:42 -0400 Subject: [PATCH 1/2] Section parsing documentation update --- docs/Section Parsing Formatting.md | 59 ++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/Section Parsing Formatting.md b/docs/Section Parsing Formatting.md index 94bf3ac..559d881 100644 --- a/docs/Section Parsing Formatting.md +++ b/docs/Section Parsing Formatting.md @@ -336,3 +336,62 @@ Mike ] } ``` +## Parse Error +An error caused by a malformed delimiter or nested delimiters. Parse errors only occur if a delimiter is incorrectly formatted or a delimiter is nested in a reply-from-user. +### Fields +| Key | Value | +| - | - | +|`type`|`parse_error`| +| `datetime` | RFC 8061 formatted datetime string. | +| `file_path` | Full path of the item with the error. | +| `expected` | Description of what the parser was expecting. | +| `got` | Line that cause the parse error. | +| `line_num` | The line number in the item that caused the parse error. | + +### Plain Text Example +``` +(item aae2 in qsnapshot) +=== Additional information supplied by user === + +Subject: RE: Help with hardware upgrades +From: "Ezra, Kristopher L" +Date: Wed, 5 Feb 2020 18:11:58 +0000 + +If it makes no difference between windows and linux for the fileserver I'd +rather service a linux machine. + +Considering the switches, i could do 2 8s and 2 16s. Two of the switches +I'm replacing already service 9 connections and I'd rather not daisy chain. +Is there something driving the price here? I see gigabit switches from +tplink on amazon right now for $50. I dont need managed switches or +anything fancy. + +Kris +*** Replied by: emuffley at: 02/05/20 13:22:02 *** + +Kris, + +Thank you on the server operating question. We will kick that off to our linux folks for discussion. + +No daisy chain, agreed. These switches are unmanaged. + +For the workstations, are you wanting Windows, Linux or a mix? + + +Eric Muffley + +Systems Engineer, Engineering Computer Network + +=============================================== +``` +### Parsed Example +```jsonc +{ + "type": "parse_error", + "datetime": "2020-10-16T10:44:45", + "file_path": "/home/pier/e/benne238/webqueue2/q-snapshot/aae/2", + "expected": "Did not encounter a reply-from-user ending delimiter", + "got": "Kris", + "line_num": 468 +} +``` \ No newline at end of file From 6650ec276e914ae1dcbbcc3999bf489054789b14 Mon Sep 17 00:00:00 2001 From: "Campbell, Justin" Date: Tue, 20 Oct 2020 20:49:24 -0400 Subject: [PATCH 2/2] Fix PR requests --- docs/Section Parsing Formatting.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/Section Parsing Formatting.md b/docs/Section Parsing Formatting.md index 559d881..3b63d11 100644 --- a/docs/Section Parsing Formatting.md +++ b/docs/Section Parsing Formatting.md @@ -336,8 +336,10 @@ Mike ] } ``` + ## Parse Error -An error caused by a malformed delimiter or nested delimiters. Parse errors only occur if a delimiter is incorrectly formatted or a delimiter is nested in a reply-from-user. +An error caused by unexpected formatting. This is not found in the item but generated when the item is parsed. + ### Fields | Key | Value | | - | - | @@ -390,8 +392,8 @@ Systems Engineer, Engineering Computer Network "type": "parse_error", "datetime": "2020-10-16T10:44:45", "file_path": "/home/pier/e/benne238/webqueue2/q-snapshot/aae/2", - "expected": "Did not encounter a reply-from-user ending delimiter", + "expected": "Did not encounter a reply_from_user ending delimiter", "got": "Kris", "line_num": 468 } -``` \ No newline at end of file +```