From d016f3bbb307f85bd0f93a508323941a8bb9d872 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 5 Aug 2020 15:07:33 -0700 Subject: [PATCH] improve documentation --- jc/parsers/airport.py | 11 +++++++---- jc/parsers/airport_s.py | 11 +++++++---- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/jc/parsers/airport.py b/jc/parsers/airport.py index a9c9f398..2a089a16 100644 --- a/jc/parsers/airport.py +++ b/jc/parsers/airport.py @@ -1,11 +1,14 @@ -"""jc - JSON CLI output utility airport -I Parser +"""jc - JSON CLI output utility airport -I command output parser + +The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`. Usage (cli): - specify --airport as the first argument if the piped input is coming from airport -I (OSX) + $ airport -I | jc --airport - This program can be found at: - /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport + or + + $ jc airport -I Usage (module): diff --git a/jc/parsers/airport_s.py b/jc/parsers/airport_s.py index 4ca18f70..be784662 100644 --- a/jc/parsers/airport_s.py +++ b/jc/parsers/airport_s.py @@ -1,11 +1,14 @@ -"""jc - JSON CLI output utility airport -s Parser +"""jc - JSON CLI output utility airport -s command parser + +The `airport` program can be found at `/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport`. Usage (cli): - specify --airport as the first argument if the piped input is coming from airport -s (OSX) + $ airport -s | jc --airport-s - This program can be found at: - /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport + or + + $ jc airport -s Usage (module):