Merge pull request #4431 from winny-/winny--patch-1

Change some language about autoconfig to be clearer
This commit is contained in:
Florian Bruhin 2018-11-29 08:33:21 +01:00 committed by GitHub
commit ccab751d3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -19,10 +19,10 @@ hand, you can simply use those - see
<<autoconfig,"Configuring qutebrowser via the user interface">> for details. <<autoconfig,"Configuring qutebrowser via the user interface">> for details.
For more advanced configuration, you can write a `config.py` file - see For more advanced configuration, you can write a `config.py` file - see
<<configpy,"Configuring qutebrowser via config.py">>. As soon as a `config.py` <<configpy,"Configuring qutebrowser via config.py">>. When a `config.py`
exists, the `autoconfig.yml` file **is not read anymore** by default. You need exists, the `autoconfig.yml` file **is not read anymore** by default. You need
to <<configpy-autoconfig,load it by hand>> if you want settings done via to <<configpy-autoconfig,load it from `config.py`>> if you want settings changed via
`:set`/`:bind` to still persist. `:set`/`:bind` to persist between restarts.
[[autoconfig]] [[autoconfig]]
Configuring qutebrowser via the user interface Configuring qutebrowser via the user interface
@ -229,18 +229,18 @@ Loading `autoconfig.yml`
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
All customization done via the UI (`:set`, `:bind` and `:unbind`) is All customization done via the UI (`:set`, `:bind` and `:unbind`) is
stored in the `autoconfig.yml` file, which is not loaded automatically as soon stored in the `autoconfig.yml` file. When a `config.py` file exists, `autoconfig.yml`
as a `config.py` exists. If you want those settings to be loaded, you'll need to is not loaded automatically. To load `autoconfig.yml` automatically, add the
explicitly load the `autoconfig.yml` file in your `config.py` by doing: following snippet to `config.py`:
.config.py:
[source,python] [source,python]
---- ----
config.load_autoconfig() config.load_autoconfig()
---- ----
If you do so at the top of your file, your `config.py` settings will take You can configure which file overrides the other by the location of the above code snippet.
precedence as they overwrite the settings done in `autoconfig.yml`. Place the snippet at the top to allow `config.py` to override `autoconfig.yml`.
Place the snippet at the bottom for the opposite effect.
Importing other modules Importing other modules
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~