chore(docs): Format with docstrfmt

This commit is contained in:
Pierre Ayoub 2026-03-08 14:42:30 +01:00 committed by Šarūnas Nejus
parent f5a08712b1
commit b798465a55
2 changed files with 9 additions and 8 deletions

View file

@ -97,12 +97,12 @@ New features
2. Semicolon followed by a space
3. Comma followed by a space
4. Slash wrapped by spaces
- :doc:`plugins/smartplaylist`: Add new configuration option ``dest_regen`` to
regenerate items' path in the generated playlist instead of using the ones of
the library. This is useful when items have been imported in don't copy-move
(`-C -M`) mode in the library but are later passed through the `convert`
plugin which will regenerate new paths according to the Beets path format.
- :doc:`plugins/lyrics`: With ``synced`` enabled, existing synced lyrics are no
longer replaced by newly fetched plain lyrics, even when ``force`` is enabled.
- :doc:`plugins/lyrics`: Remove ``Source: <lyrics-url>`` suffix from lyrics.

View file

@ -156,8 +156,8 @@ options are:
- **dest_regen**: Regenerate the destination path as 'move' or 'convert'
commands would do. This operation will happen before ``relative_to`` and
``prefix``. Helpful to generate playlists compatible with the ``convert``
plugin when items have been imported with the `-C -M` options.
Default: ``false``
plugin when items have been imported with the `-C -M` options. Default:
``false``
- **relative_to**: Generate paths in the playlist files relative to a base
directory. If you intend to use this plugin to generate playlists for MPD,
point this to your MPD music directory. Default: Use absolute paths.
@ -172,8 +172,8 @@ options are:
that will be written to the m3u file. Default: ``false``.
- **uri_format**: Template with an ``$id`` placeholder used generate a playlist
item URI, e.g. ``http://beets:8337/item/$id/file``. When this option is
specified, the local path-related options ``dest_regen``, ``prefix``, ``relative_to``,
``forward_slash`` and ``urlencode`` are ignored.
specified, the local path-related options ``dest_regen``, ``prefix``,
``relative_to``, ``forward_slash`` and ``urlencode`` are ignored.
- **output**: Specify the playlist format: m3u|extm3u. Default ``m3u``.
- **fields**: Specify the names of the additional item fields to export into the
playlist. This allows using e.g. the ``id`` field within other tools such as
@ -181,6 +181,7 @@ options are:
``output`` option to ``extm3u``.
For many configuration options, there is a corresponding CLI option, e.g.
``--playlist-dir``, ``--dest-regen``, ``--relative-to``, ``--prefix``, ``--forward-slash``,
``--urlencode``, ``--uri-format``, ``--output``, ``--pretend-paths``. CLI
options take precedence over those specified within the configuration file.
``--playlist-dir``, ``--dest-regen``, ``--relative-to``, ``--prefix``,
``--forward-slash``, ``--urlencode``, ``--uri-format``, ``--output``,
``--pretend-paths``. CLI options take precedence over those specified within the
configuration file.