Commit graph

22 commits

Author SHA1 Message Date
Šarūnas Nejus
ab5acaabb3
Reformat all docs using docstrfmt 2025-08-10 16:25:05 +01:00
Šarūnas Nejus
769dcdc88a
Docs: fix linting issues 2025-08-10 16:16:02 +01:00
Carl Suster
2e0230789f docs: fix some markup issues and typos 2019-04-27 12:43:13 +10:00
Adrian Sampson
5cb1bea1a6 Add a warning to the bucket docs (fix #3045) 2018-10-08 17:45:27 -04:00
Fabrice Laporte
f7ecb9cbae doc: emphasize options names by using bold font instead of fixed width 2014-11-07 22:13:25 +01:00
Fabrice Laporte
0a1e3dd25f Update bucket.rst 2014-10-31 23:13:34 +01:00
Adrian Sampson
e80f84e666 Typo fixes 2014-10-31 09:48:19 -07:00
Adrian Sampson
613c85ad6e Plugin docs overhaul tweaks through "duplicates"
Moving alphabetically through the docs. Got a long way to go...
2014-10-30 11:42:27 -07:00
Fabrice Laporte
ca1d6a9899 always a colon between the option name and the rest of the description
plus typos and case change
2014-10-29 22:33:13 +01:00
Fabrice Laporte
b922abef06 docs: remove space before colon 2014-10-28 23:23:44 +01:00
Fabrice Laporte
2cd76b6714 docs: add plugin name in "how to configure" sentences 2014-10-28 23:23:10 +01:00
Fabrice Laporte
cb350de2ea harmonize all plugins docs
Add a configuration section that lists all options for each plugin.
List options in alphabetic order.
Mention the default value for each option.
Use same sentences to describe concepts common to different plugins eg 'auto
option, install description
2014-10-26 22:29:10 +01:00
Fabrice Laporte
c8b89da4b9 Update bucket.rst 2014-10-13 00:08:03 +02:00
Alexander Elbs
9ca816f247 the bucket plugin transforms a pattern like 'A - D' into something that
matches all letters starting with A to D (upper and lower case). This
change allows to put more artists into that bucket. E.g. artists
starting with ä or Ä and 0 to 9 and … (three dots)

Example config for overriding a bucket pattern:

  bucket:
     bucket_alpha: ['A - D', 'E - L', 'M - R', 'S - Z']
     bucket_alpha_regex:
       'A - D': ^[0-9a-dA-D…äÄ]
2014-06-30 20:55:28 +02:00
Adrian Sampson
7310f6e945 Documentation tweaks for bucket (#747) 2014-05-10 17:14:35 -07:00
Fabrice L.
0442e6648c Update bucket.rst 2014-05-10 23:34:52 +02:00
Fabrice Laporte
21feab7ab1 add tests to check bad buckets definitions
message is now printed to the user when buckets declared in the config
file cannot be parsed
2014-05-10 10:55:38 +02:00
Fabrice Laporte
4add189608 Add option to extrapolate year buckets names
- spans are now tracked via a list of dicts instead of 2 lists
previously (simpler code)
- extend_year_spans() pregenerates all possible ranges at plugin setup
stage
- a BucketError is now raised if declared bucket format not accepted
2014-05-08 01:28:17 +02:00
Fabrice Laporte
a138c4989e include bucket.rst in toc tree 2014-05-04 07:41:02 +02:00
Fabrice L.
8a7f82f354 Update bucket.rst 2014-05-04 07:09:36 +02:00
Fabrice L.
67b3d78b72 Update bucket.rst 2014-05-04 00:04:18 +02:00
Fabrice Laporte
b1d10ed5f9 add bucket plugin doc 2014-05-03 23:48:23 +02:00