zoriya/guessit
1
0
Fork 0
mirror of https://github.com/zoriya/guessit.git synced 2026-06-03 02:41:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix configuration docs

Browse Source
This commit is contained in:
Rémi Alvergnat
2018-10-18 23:29:36 +02:00
parent b20d44ee68
commit b05aa64c73
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
HISTORY.rst
+2 -2
View File
@@ -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`)
docs/configuration.rst
+6 -6
View File
@@ -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 <https://github.com/guessit-io/guessit/blob/develop/guessit/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