Skip to content

Commit 5a75bab

Browse files
committed
Update docs to indicate the shared musicbrainz options
1 parent 23176f1 commit 5a75bab

File tree

5 files changed

+32
-3
lines changed

5 files changed

+32
-3
lines changed

docs/plugins/listenbrainz.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ intructions here_) and username:
2626
token: TOKEN
2727
username: LISTENBRAINZ_USERNAME
2828

29+
Other ``musicbrainz`` options may be set to modify the connection to MusicBrainz
30+
(see :ref:`musicbrainz-shared-options`).
31+
2932
Usage
3033
-----
3134

docs/plugins/mbcollection.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ To begin, just enable the ``mbcollection`` plugin in your configuration (see
1616
user: you
1717
pass: seekrit
1818

19+
Other ``musicbrainz`` options may be set to modify the connection to MusicBrainz
20+
(see :ref:`musicbrainz-shared-options`).
21+
1922
Then, use the ``beet mbupdate`` command to send your albums to MusicBrainz. The
2023
command automatically adds all of your albums to the first collection it finds.
2124
If you don't have a MusicBrainz collection yet, you may need to add one to your

docs/plugins/missing.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ Here's an example
5757
count: no
5858
total: no
5959

60+
Other ``musicbrainz`` options may be set to modify the connection to MusicBrainz
61+
(see :ref:`musicbrainz-shared-options`).
62+
6063
Template Fields
6164
---------------
6265

docs/plugins/musicbrainz.rst

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,28 @@ only to custom servers. The official MusicBrainz server always uses HTTPS.
5858
(Default: no.) The server must have search indices enabled (see `Building search
5959
indexes`_).
6060

61-
The ``ratelimit`` option, an integer, controls the number of Web service
62-
requests per second (default: 1). **Do not change the rate limit setting** if
63-
you're using the main MusicBrainz server---on this public server, you're
61+
The ``ratelimit`` and ``ratelimit_interval`` options, respectively an integer
62+
and a decimal number, control the number of Web service requests per interval of
63+
time (default: 1 request per second). **Do not change the rate limit setting**
64+
if you're using the main MusicBrainz server---on this public server, you're
6465
limited_ to one request per second.
6566

67+
.. _musicbrainz-shared-options:
68+
69+
Shared options
70+
~~~~~~~~~~~~~~
71+
72+
As other plugins may send requests to the MusicBrainz API, the following
73+
``musicbrainz`` options will also modify the other plugins' connection to
74+
MusicBrainz, even if the ``musicbrainz`` plugin is disabled:
75+
76+
- ``host``
77+
- ``https``
78+
- ``ratelimit``
79+
- ``ratelimit_interval``
80+
- ``user``
81+
- ``pass``
82+
6683
.. _building search indexes: https://musicbrainz.org/doc/Development/Search_server_setup
6784

6885
.. _limited: https://musicbrainz.org/doc/XML_Web_Service/Rate_Limiting

docs/plugins/parentwork.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,6 @@ file. The available options are:
5454
- **auto**: If enabled, automatically fetches works at import. It takes quite
5555
some time, because beets is restricted to one MusicBrainz query per second.
5656
Default: ``no``
57+
58+
Other ``musicbrainz`` options may be set to modify the connection to MusicBrainz
59+
(see :ref:`musicbrainz-shared-options`).

0 commit comments

Comments
 (0)