diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2020-02-03 09:40:17 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-03 09:40:17 -0600 |
| commit | 577c788b32db3100c05e043ce301e8995b58e377 (patch) | |
| tree | 0e2d263549f1e2cff699e1b1fd26627b10e054fa | |
| parent | Add requests to tox (diff) | |
| download | config-file-577c788b32db3100c05e043ce301e8995b58e377.zip | |
Fix json parser class docstring
| -rw-r--r-- | config_file/parsers/json_parser.py | 14 |
1 files changed, 3 insertions, 11 deletions
diff --git a/config_file/parsers/json_parser.py b/config_file/parsers/json_parser.py index 8e4617b..07696b8 100644 --- a/config_file/parsers/json_parser.py +++ b/config_file/parsers/json_parser.py @@ -16,17 +16,9 @@ class JsonParser(BaseParser): """ The JsonParser allows use of json files with ConfigFile. The syntax it supports is a bit more flexible than the IniParser. - - Since you can have deeply nested structures with JSON, the JsonParser supports - a catch all where you can get/set/delete all occurrences of a particular - key. This is the default behavior if you only specify a single word key. - - If there is a '.' in the key, it is assumed you want to use the dot syntax - then. - - If no '.' is in the key parameter and we have specified we're only - trying to fetch a top level item with 'top_level_only=True', the parser - only retrieve the key in the top most level. + + By default, the dot syntax is used. However, if you'd like to get/set/delete all + of a particular key, you can specify so with an optional parameter. Example: |