From 3f221f471416766a860bd19850afda4899ee5eb3 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 20 Sep 2021 13:21:20 -0700 Subject: [PATCH] doc update --- docs/parsers/ping_s.md | 6 ++++-- jc/parsers/ping_s.py | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 56a1a5f4..77847bc7 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -3,10 +3,14 @@ # jc.parsers.ping_s jc - JSON CLI output utility `ping` command output streaming parser +Supports `ping` and `ping6` output. + Usage (cli): $ ping | jc --ping-s +> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information. + Usage (module): import jc.parsers.ping_s @@ -14,8 +18,6 @@ Usage (module): for item in result: # do something -> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information. - Schema: { diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index 42f18f5a..adcd5c06 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -1,9 +1,13 @@ """jc - JSON CLI output utility `ping` command output streaming parser +Supports `ping` and `ping6` output. + Usage (cli): $ ping | jc --ping-s +> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information. + Usage (module): import jc.parsers.ping_s @@ -11,8 +15,6 @@ Usage (module): for item in result: # do something -> Note: When piping `jc` output to other processes it may appear the output is hanging due to the OS pipe buffers. This is because `ping` output is too small to quickly fill up the buffer. Use the `-u` option to unbuffer the `jc` output if you would like immediate output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/streaming#streaming-parsers) for more information. - Schema: {