From 5473bc4eb697d00bd26a038287e1137e438cacb5 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 12 Nov 2019 11:12:41 -0800 Subject: [PATCH] doc update --- docs/parsers/arp.md | 11 ++++++++--- jc/parsers/arp.py | 11 ++++++++--- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index bf3c37d1..69a7ddd0 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -103,8 +103,13 @@ parse(data, raw=False, quiet=False) Main parsing function -Arguments: +Parameters: - raw: (boolean) output preprocessed JSON if True - quiet: (boolean) suppress warning messages if True + data: (string) text data to parse + raw: (boolean) output preprocessed JSON if True + quiet: (boolean) suppress warning messages if True + +Returns: + + dictionary raw or processed structured data diff --git a/jc/parsers/arp.py b/jc/parsers/arp.py index 4ca7c2b1..6d150259 100644 --- a/jc/parsers/arp.py +++ b/jc/parsers/arp.py @@ -108,10 +108,15 @@ def parse(data, raw=False, quiet=False): """ Main parsing function - Arguments: + Parameters: + + data: (string) text data to parse + raw: (boolean) output preprocessed JSON if True + quiet: (boolean) suppress warning messages if True - raw: (boolean) output preprocessed JSON if True - quiet: (boolean) suppress warning messages if True + Returns: + + dictionary raw or processed structured data """ # compatible options: linux, darwin, cygwin, win32, aix, freebsd