From f0a14bfdd530e1ddc8cc67316f458de6996c8a55 Mon Sep 17 00:00:00 2001 From: Diego Moreda Date: Tue, 4 Oct 2016 16:20:52 +0200 Subject: [PATCH] Fix documentation issues for %first Fix a formatting problem related to sphinx not allowing spaces at the beginning or end of an inline literal, and removed an extra sentence at th end of the %first template function documentation. --- docs/reference/pathformat.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/pathformat.rst b/docs/reference/pathformat.rst index 240534a9a..72453a6e5 100644 --- a/docs/reference/pathformat.rst +++ b/docs/reference/pathformat.rst @@ -76,12 +76,12 @@ These functions are built in to beets: * ``%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 library, use ``%time{$added,%Y}``. -* ``%first{text}``: Returns the first item, separated by ``; ``. +* ``%first{text}``: Returns the first item, separated by ``;`` (a semicolon + followed by a space). You can use ``%first{text,count,skip}``, where ``count`` is the number of items (default 1) and ``skip`` is number to skip (default 0). You can also use ``%first{text,count,skip,sep,join}`` where ``sep`` is the separator, like ``;`` or ``/`` and join is the text to concatenate the items. - For example, * ``%ifdef{field}``, ``%ifdef{field,truetext}`` or ``%ifdef{field,truetext,falsetext}``: If ``field`` exists, then return ``truetext`` or ``field`` (default). Otherwise, returns ``falsetext``.