From c5764df9893d9b4d65a3be473a5ea32fd58e9181 Mon Sep 17 00:00:00 2001 From: Edgars Supe Date: Fri, 10 Sep 2021 09:51:56 +0300 Subject: [PATCH] Improve `albumtypes` plugin documentation --- docs/plugins/albumtypes.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/plugins/albumtypes.rst b/docs/plugins/albumtypes.rst index dd32596d6..f97a11a71 100644 --- a/docs/plugins/albumtypes.rst +++ b/docs/plugins/albumtypes.rst @@ -2,14 +2,14 @@ AlbumTypes Plugin ================= The ``albumtypes`` plugin adds the ability to format and output album types, -such as "Album", "EP", "Single", etc. List of available type can be found -`here`_. +such as "Album", "EP", "Single", etc. For the list of available album types, +see the `MusicBrainz documentation`_. To use the ``albumtypes`` plugin, enable it in your configuration -(see :ref:`using-plugins`). Then, add ``$atypes`` to your path formats as -desired. +(see :ref:`using-plugins`). The plugin defines a new field ``$atypes``, which +you can use in your path formats or elsewhere. -.. _here: https://musicbrainz.org/doc/Release_Group/Type +.. _MusicBrainz documentation: https://musicbrainz.org/doc/Release_Group/Type Configuration ------------- @@ -48,10 +48,9 @@ Example config:: albumtype:soundtrack Various Artists/$album ($year)$atypes)/... comp: Various Artists/$album ($year)$atypes/... -Example outputs:: +This configuration generates paths that look like this, for example:: Aphex Twin/(1993)(EP)(Remix) On Remixes Pink Flow/(1995)(Live) p·u·l·s·e Various Artists/20th Century Lullabies (1999) Various Artists/Ocean's Eleven (2001)(OST) -