From b05aa64c736efcd9fadae81d415795e6104f2a3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Alvergnat?= Date: Thu, 18 Oct 2018 23:29:36 +0200 Subject: [PATCH] Fix configuration docs --- HISTORY.rst | 4 ++-- docs/configuration.rst | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index e0b2167..e0dc06d 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -10,8 +10,8 @@ History 3.0.2 (2018-10-18) ------------------ -- Ensure consistent behavior between CLI and Python module. It's now possible to override `advanced_configuration` at -runtime through options dict. Rebulk rules are lazily rebuilt when `advanced_configuration` is changed since previous +- Ensure consistent behavior between CLI and Python module. It's now possible to override `advanced_config` at +runtime through options dict. Rebulk rules are lazily rebuilt when `advanced_config` is changed since previous call. - Refactored command line options and loading behavior related to configuration files (see `-c CONFIG`, `--config CONFIG`, `--no-user-config`, `--no-default-config`) diff --git a/docs/configuration.rst b/docs/configuration.rst index 6dadd04..83f559f 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -2,34 +2,34 @@ Configuration files =================== -Guessit supports configuration through configuration file. - -This can be done using the ``-c``/``--config`` option, or by creating files at the following locations. +Guessit supports configuration through configuration files. Default configuration file is bundled inside guessit package from `config/options.json `_ file. It is possible to disable the default configuration with ``--no-default-config`` option, but you have then to provide a full configuration file based on the default one. -Configuration files are also loaded from the following paths: +Configuration files are loaded from the following paths: * ``~/.guessit/options.(json|yml|yaml)`` * ``~/.config/guessit/options.(json|yml|yaml)`` It is also possible to disable those user configuration files with ``no-user-config`` option. +Additional configuration files can be included using the ``-c``/``--config`` option. + As many configuration files can be involved, they are deeply merged to keep all values inside the effective configuration. Advanced configuration ====================== Configuration files contains all options available through the command line, but also an additional one named -``advanced_configuration``. +``advanced_config``. This advanced configuration contains all internal parameters and they are exposed to help you tweaking guessit to better fit your needs. -If no ``advanced_configuration`` is declared through all effective configuration files, the default one will be used +If no ``advanced_config`` is declared through all effective configuration files, the default one will be used even when ``--no-default-config`` is used. We're willing to keep it backwards compatible, but in order to enhance Guessit, these parameters might change without