From 125dc2d9e051a82a4a438afe2e520212338353f5 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Fri, 24 Jul 2020 16:17:16 -0700 Subject: [PATCH] add info about key/value files to doc --- docs/parsers/ini.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index 41ecc5bc..93e6091b 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -3,7 +3,9 @@ jc - JSON CLI output utility INI Parser Usage: - specify --ini as the first argument if the piped input is coming from an INI file + Specify --ini as the first argument if the piped input is coming from an INI file or any + simple key/value pair file. Delimiter can be '=' or ':'. Missing values are supported. + Comment prefix can be '#' or ';'. Comments must be on their own line. Compatibility: @@ -64,8 +66,11 @@ Returns: Dictionary representing an ini document: { - ini document converted to a dictionary - see configparser standard library documentation for more details + ini or key/value document converted to a dictionary - see configparser standard + library documentation for more details. + + Note: Values starting and ending with quotation marks will have the marks removed. + If you would like to keep the quotation markes, use the -r or raw=True argument. } ## parse