search

bw2 / ConfigArgParse

A drop-in replacement for argparse that allows options to also be set via config files and/or environment variables.
MIT License
719 stars 121 forks source link

Update yaml doc #277

Closed sdarwin closed 1 year ago

sdarwin commented 2 years ago

Hi,

A nice way of using lists in yaml is 

my_variable:
  - value1
  - value2
  - value3

Naively following the documentation to initially set up ConfigArgParse it seemed to accept some yaml input

name: value    # (yaml style)

but not the above mentioned type of list.

There is a quote about "subset of YAML syntax".

However, it turns out that the yaml style list is supported. ;-) Since that's the case, could be a bit clearer to show it in the docs.

bw2 commented 1 year ago

Thanks for the PR