Fix formatting issues

This commit is contained in:
Šarūnas Nejus 2025-09-04 12:25:22 +01:00
parent f8a98ac518
commit 4cb667cbb3
No known key found for this signature in database
GPG key ID: DD28F6704DBE3435
2 changed files with 10 additions and 10 deletions

View file

@ -88,9 +88,9 @@ Beets already ships with several metadata source plugins. Studying these
implementations can help you follow conventions and avoid pitfalls. Good
starting points include:
- `spotify`
- `deezer`
- `discogs`
- ``spotify``
- ``deezer``
- ``discogs``
Migration guidance
------------------

View file

@ -2,10 +2,10 @@ Read Configuration Options
==========================
Plugins can configure themselves using the ``config.yaml`` file. You can read
configuration values in two ways. The first is to use `self.config` within your
plugin class. This gives you a view onto the configuration values in a section
with the same name as your plugin's module. For example, if your plugin is in
``greatplugin.py``, then `self.config` will refer to options under the
configuration values in two ways. The first is to use ``self.config`` within
your plugin class. This gives you a view onto the configuration values in a
section with the same name as your plugin's module. For example, if your plugin
is in ``greatplugin.py``, then ``self.config`` will refer to options under the
``greatplugin:`` section of the config file.
For example, if you have a configuration value called "foo", then users can put
@ -17,19 +17,19 @@ this in their ``config.yaml``:
foo: bar
To access this value, say ``self.config['foo'].get()`` at any point in your
plugin's code. The `self.config` object is a *view* as defined by the Confuse_
plugin's code. The ``self.config`` object is a *view* as defined by the Confuse_
library.
.. _confuse: https://confuse.readthedocs.io/en/latest/
If you want to access configuration values *outside* of your plugin's section,
import the `config` object from the `beets` module. That is, just put ``from
import the ``config`` object from the ``beets`` module. That is, just put ``from
beets import config`` at the top of your plugin and access values from there.
If your plugin provides configuration values for sensitive data (e.g.,
passwords, API keys, ...), you should add these to the config so they can be
redacted automatically when users dump their config. This can be done by setting
each value's `redact` flag, like so:
each value's ``redact`` flag, like so:
::