Skip to content

Commit

Permalink
Doc tweaks for beetbox#4438
Browse files Browse the repository at this point in the history
  • Loading branch information
sampsyo authored and JOJ0 committed Oct 15, 2022
1 parent 8ad7cf4 commit 0a2b8b4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 4 additions & 2 deletions docs/reference/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/pathformat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <aunique>` template, but the default
values are different. The default identifiers are ``artist title`` and the
Expand Down

0 comments on commit 0a2b8b4

Please sign in to comment.