Skip to content

Commit 159f43c

Browse files
authored
Update missing plugin configuration options and formatting details (#6025)
Missing plugin documentation was not right. The `format` option does not work. Updated it to reflect the use of global album and item format.
2 parents 2c1aa27 + de4494a commit 159f43c

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/plugins/missing.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,27 @@ Configuration
3939
To configure the plugin, make a ``missing:`` section in your configuration file.
4040
The available options are:
4141

42-
- **count**: Print a count of missing tracks per album, with ``format``
43-
defaulting to ``$albumartist - $album: $missing``. Default: ``no``.
44-
- **format**: A specific format with which to print every track. This uses the
45-
same template syntax as beets' :doc:`path formats </reference/pathformat>`.
46-
The usage is inspired by, and therefore similar to, the :ref:`list <list-cmd>`
47-
command. Default: :ref:`format_item`.
42+
- **count**: Print a count of missing tracks per album, with the global
43+
``format_album`` used for formatting. Default: ``no``.
4844
- **total**: Print a single count of missing tracks in all albums. Default:
4945
``no``.
5046

47+
Formatting
48+
~~~~~~~~~~
49+
50+
- This plugin uses global formatting options from the main configuration; see
51+
:ref:`format_item` and :ref:`format_album`:
52+
- :ref:`format_item`: Used when listing missing tracks (default item format).
53+
- :ref:`format_album`: Used when showing counts (``-c``) or missing albums
54+
(``-a``).
55+
5156
Here's an example
5257

5358
::
5459

60+
format_album: $albumartist - $album
61+
format_item: $artist - $album - $title
5562
missing:
56-
format: $albumartist - $album - $title
5763
count: no
5864
total: no
5965

0 commit comments

Comments
 (0)