From e995019edd68329c28647d651c7766dafeace1a4 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Wed, 17 Aug 2022 15:55:25 -0700 Subject: [PATCH] Doc tweaks for #4438 --- docs/reference/config.rst | 6 ++++-- docs/reference/pathformat.rst | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/reference/config.rst b/docs/reference/config.rst index 58656256f9..26a07e643d 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -326,13 +326,15 @@ The defaults look like this:: See :ref:`aunique` for more details. + .. _config-sunique: sunique ~~~~~~~ -These options are used to generate a string that is guaranteed to be unique -among all singletons in the library who share the same set of keys. +Like :ref:`config-aunique` above for albums, these options control the +generation of a unique string to disambiguate *singletons* that share similar +metadata. The defaults look like this:: diff --git a/docs/reference/pathformat.rst b/docs/reference/pathformat.rst index b52c2b32a3..7c52a92eb2 100644 --- a/docs/reference/pathformat.rst +++ b/docs/reference/pathformat.rst @@ -73,7 +73,7 @@ These functions are built in to beets: option. * ``%aunique{identifiers,disambiguators,brackets}``: Provides a unique string to disambiguate similar albums in the database. See :ref:`aunique`, below. -* ``%sunique{identifiers,disambiguators,brackets}``: Provides a unique string +* ``%sunique{identifiers,disambiguators,brackets}``: Similarly, a unique string to disambiguate similar singletons in the database. See :ref:`sunique`, below. * ``%time{date_time,format}``: Return the date and time in any format accepted by `strftime`_. For example, to get the year some music was added to your @@ -153,8 +153,8 @@ Singleton Disambiguation ------------------------ It is also possible to have singleton tracks with the same name and the same -artist. Beets provides the ``%sunique{}`` template to avoid having the same -file path. +artist. Beets provides the ``%sunique{}`` template to avoid giving these +tracks the same file path. It has the same arguments as the :ref:`%aunique ` template, but the default values are different. The default identifiers are ``artist title`` and the