python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-08-08 22:36:48 +02:00
Code Issues Releases Activity

add info about key/value files to doc

Browse Source
This commit is contained in:
Kelly Brazil
2020-07-24 16:17:16 -07:00
parent b7d4ddc7ce
commit 125dc2d9e0
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/parsers/ini.md
View File

@ -3,7 +3,9 @@ jc - JSON CLI output utility INI Parser
Usage: 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: Compatibility:
@ -64,8 +66,11 @@ Returns:
Dictionary representing an ini document: Dictionary representing an ini document:
{ {
ini document converted to a dictionary ini or key/value document converted to a dictionary - see configparser standard
see configparser standard library documentation for more details 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 ## parse