Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-26 18:43:38 +01:00
Code Issues Projects Releases Wiki Activity

Add a warning to the bucket docs (fix #3045)

Browse source
This commit is contained in:
Adrian Sampson 2018-10-08 17:45:27 -04:00
parent 3b78d933cf
commit 5cb1bea1a6
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/plugins/bucket.rst
View file

@ -21,7 +21,7 @@ Then, define your ranges in the ``bucket:`` section of the config file::
bucket_alpha: ['A-F', 'G-M', 'N-Z']
bucket_year: ['1980s', '1990s', '2000s']
The ``bucket_year`` parameter is used for all substitutions occuring on the
The ``bucket_year`` parameter is used for all substitutions occurring on the
``$year`` field, while ``bucket_alpha`` takes care of textual fields.
The definition of a range is somewhat loose, and multiple formats are allowed:
@ -35,6 +35,13 @@ The definition of a range is somewhat loose, and multiple formats are allowed:
(unless a later range is defined). For example, *1975* encompasses all years
from 1975 until now.
The `%bucket` template function guesses whether to use alpha- or year-style
buckets depending on the text it receives. It can guess wrong if, for example,
an artist or album happens to begin with four digits. Provide `alpha` as the
second argument to the template to avoid this automatic detection: for
example, use `%bucket{$artist,alpha}`.
Configuration
-------------