Quick Guide is missing
nikosT opened this issue · 3 comments
The documentation for quick use is not straight forward. Someone will need a lot of time to understand how this library works.
For me the most non-obvious thing was that one has to have a config_default.yaml inside your own library. Maybe this could be highlighted a bit more clearly in the documentation.
As a side note, I'd really prefer giving the name/file_path of the configuration file template as an argument to the confuse.Configuration()
The documentation is indeed somewhat lacking, both in terms of quickstart and more detail on the API. For instance, the example under "your application directory" makes use of a variable called confuse.CONFIG_FILENAME, but this variable is not documented anywhere.
Also, there is no explicit description in the documentation of how confuse maps configuration keys onto YAML files, or what the filenames of the config files are, etc. This makes it difficult to get started because the documentation only describes how to read existing configuration files, but not how to create them.
There are all manner of issues that were resolved by telling people to use .set_file or various things in confuse.util, none of which are documented. The readme says that the documentation describes the API "in detail" but it is quite far from doing this.
Quite true! We would love help getting that documentation started if anyone has time to open a PR.