Skip to content

Commit cec9dc5

Browse files
committed
Docs: fix long lines
1 parent ed4ac40 commit cec9dc5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+529
-405
lines changed

docs/_templates/autosummary/class.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
.. currentmodule:: {{ module }}
44

55
.. autoclass:: {{ objname }}
6-
:members: <-- add at least this line
6+
:members: <-- add at least this line
77
:private-members:
8-
:show-inheritance: <-- plus I want to show inheritance...
9-
:inherited-members: <-- ...and inherited members too
8+
:show-inheritance: <-- plus I want to show inheritance...
9+
:inherited-members: <-- ...and inherited members too
1010

1111
{% block methods %}
1212
.. automethod:: __init__
@@ -25,4 +25,3 @@
2525
{% endblock %}
2626

2727
.. rubric:: {{ _('Methods definition') }}
28-

docs/changelog.rst

Lines changed: 161 additions & 107 deletions
Large diffs are not rendered by default.

docs/dev/library.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ You can add new items or albums to the library via the
2727
:py:meth:`Library.add` and :py:meth:`Library.add_album` methods.
2828

2929
You may also query the library for items and albums using the
30-
:py:meth:`Library.items`, :py:meth:`Library.albums`, :py:meth:`Library.get_item` and :py:meth:`Library.get_album` methods.
30+
:py:meth:`Library.items`, :py:meth:`Library.albums`, :py:meth:`Library.get_item`
31+
and :py:meth:`Library.get_album` methods.
3132

3233
Any modifications to the library must go through a
3334
:class:`Transaction` object, which you can get using the

docs/dev/plugins.rst

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -267,20 +267,18 @@ The events currently available are:
267267
during a ``beet import`` interactive session. Plugins can use this event for
268268
:ref:`appending choices to the prompt <append_prompt_choices>` by returning a
269269
list of ``PromptChoices``. Parameters: ``task`` and ``session``.
270-
271-
* `mb_track_extract`: called after the metadata is obtained from
272-
MusicBrainz. The parameter is a ``dict`` containing the tags retrieved from
273-
MusicBrainz for a track. Plugins must return a new (potentially empty)
274-
``dict`` with additional ``field: value`` pairs, which the autotagger will
275-
apply to the item, as flexible attributes if ``field`` is not a hardcoded
276-
field. Fields already present on the track are overwritten.
277-
Parameter: ``data``
278-
270+
* `mb_track_extract`: called after the metadata is obtained from MusicBrainz.
271+
The parameter is a ``dict`` containing the tags retrieved from MusicBrainz for
272+
a track. Plugins must return a new (potentially empty) ``dict`` with
273+
additional ``field: value`` pairs, which the autotagger will apply to the
274+
item, as flexible attributes if ``field`` is not a hardcoded field. Fields
275+
already present on the track are overwritten. Parameter: ``data``
279276
* `mb_album_extract`: Like `mb_track_extract`, but for album tags. Overwrites
280-
tags set at the track level, if they have the same ``field``.
281-
Parameter: ``data``
277+
tags set at the track level, if they have the same ``field``. Parameter:
278+
``data``
282279

283-
The included ``mpdupdate`` plugin provides an example use case for event listeners.
280+
The included ``mpdupdate`` plugin provides an example use case for event
281+
listeners.
284282

285283
Extend the Autotagger
286284
^^^^^^^^^^^^^^^^^^^^^
@@ -462,9 +460,9 @@ Multiple stages run in parallel but each stage processes only one task at a time
462460
and each task is processed by only one stage at a time.
463461

464462
Plugins provide stages as functions that take two arguments: ``config`` and
465-
``task``, which are ``ImportSession`` and ``ImportTask`` objects (both defined in
466-
``beets.importer``). Add such a function to the plugin's ``import_stages`` field
467-
to register it::
463+
``task``, which are ``ImportSession`` and ``ImportTask`` objects (both defined
464+
in ``beets.importer``). Add such a function to the plugin's ``import_stages``
465+
field to register it::
468466

469467
from beets.plugins import BeetsPlugin
470468
class ExamplePlugin(BeetsPlugin):

docs/faq.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,11 @@ it's helpful to run on the "bleeding edge". To run the latest source:
161161
git clone https://github.com/beetbox/beets.git
162162
poetry install
163163
164-
This approach lets you decide where the
165-
source is stored, with any changes immediately reflected in your
166-
environment.
164+
This approach lets you decide where the source is stored, with any
165+
changes immediately reflected in your environment.
167166

168-
More details about the beets source are available on the :doc:`developer documentation </dev/index>`
169-
pages.
167+
More details about the beets source are available on the :doc:`developer
168+
documentation </dev/index>` pages.
170169

171170

172171
.. _bugs:
@@ -240,7 +239,8 @@ move all your files.
240239
If you've already moved your music *outside* of beets, you have a few options:
241240

242241
- Move the music back (with an ordinary ``mv``) and then use the above steps.
243-
- Delete your database and re-create it from the new paths using ``beet import -AWC``.
242+
- Delete your database and re-create it from the new paths using ``beet import
243+
-AWC``.
244244
- Resort to manually modifying the SQLite database (not recommended).
245245

246246

docs/guides/advanced.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ using the :ref:`modify-cmd` command::
109109

110110
By default, beets will show you the changes that are about to be applied and ask
111111
if you really want to apply them to all, some or none of the items or albums.
112-
You can type y for "yes", n for "no", or s for "select". If you choose the latter,
113-
the command will prompt you for each individual matching item or album.
112+
You can type y for "yes", n for "no", or s for "select". If you choose the
113+
latter, the command will prompt you for each individual matching item or album.
114114

115115
Then :doc:`query </reference/query>` your music just as you would with any
116116
other field::

docs/guides/main.rst

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,33 @@ Beets works on Python 3.8 or later.
2121
* On **Debian or Ubuntu**, depending on the version, beets is available as an
2222
official package (`Debian details`_, `Ubuntu details`_), so try typing:
2323
``apt-get install beets``. But the version in the repositories might lag
24-
behind, so make sure you read the right version of these docs. If you want
25-
the latest version, you can get everything you need to install with pip
26-
as described below by running:
27-
``apt-get install python-dev python-pip``
28-
29-
* On **Arch Linux**, `beets is in [extra] <Arch extra_>`_, so just run ``pacman -S
30-
beets``. (There's also a bleeding-edge `dev package <AUR_>`_ in the AUR, which will
31-
probably set your computer on fire.)
32-
33-
* On **Alpine Linux**, `beets is in the community repository <Alpine package_>`_
34-
and can be installed with ``apk add beets``.
24+
behind, so make sure you read the right version of these docs. If you want the
25+
latest version, you can get everything you need to install with pip as
26+
described below by running: ``apt-get install python-dev python-pip``
27+
* On **Arch Linux**, `beets is in [extra] <Arch extra_>`_, so just run ``pacman
28+
-S beets``. (There's also a bleeding-edge `dev package <AUR_>`_ in the AUR,
29+
which will probably set your computer on fire.)
30+
* On **Alpine Linux**, `beets is in the community repository <Alpine
31+
package_>`_ and can be installed with ``apk add beets``.
3532

3633
* For **Gentoo Linux**, beets is in Portage as ``media-sound/beets``. Just run
3734
``emerge beets`` to install. There are several USE flags available for
3835
optional plugin dependencies.
3936

4037
* On **FreeBSD**, there's a `beets port <FreeBSD_>`_ at ``audio/beets``.
4138

42-
* On **OpenBSD**, there's a `beets port <OpenBSD_>`_ can be installed with ``pkg_add beets``.
39+
* On **OpenBSD**, there's a `beets port <OpenBSD_>`_ can be installed with
40+
``pkg_add beets``.
4341

4442
* For **Slackware**, there's a `SlackBuild`_ available.
4543

46-
* On **Fedora** 22 or later, there's a `DNF package`_ you can install with ``sudo dnf install beets beets-plugins beets-doc``.
44+
* On **Fedora** 22 or later, there's a `DNF package`_ you can install with
45+
``sudo dnf install beets beets-plugins beets-doc``.
4746

4847
* On **Solus**, run ``eopkg install beets``.
4948

50-
* On **NixOS**, there's a `package <NixOS_>`_ you can install with ``nix-env -i beets``.
49+
* On **NixOS**, there's a `package <NixOS_>`_ you can install with ``nix-env -i
50+
beets``.
5151

5252
.. _DNF package: https://packages.fedoraproject.org/pkgs/beets/
5353
.. _SlackBuild: https://slackbuilds.org/repository/14.2/multimedia/beets/
@@ -277,13 +277,15 @@ put the field before the term, separated by a : character. So ``album:bird``
277277
only looks for ``bird`` in the "album" field of your songs. (Need to know more?
278278
:doc:`/reference/query/` will answer all your questions.)
279279

280-
The ``beet list`` command also has an ``-a`` option, which searches for albums instead of songs::
280+
The ``beet list`` command also has an ``-a`` option, which searches for albums
281+
instead of songs::
281282

282283
$ beet ls -a forever
283284
Bon Iver - For Emma, Forever Ago
284285
Freezepop - Freezepop Forever
285286

286-
There's also an ``-f`` option (for *format*) that lets you specify what gets displayed in the results of a search::
287+
There's also an ``-f`` option (for *format*) that lets you specify what gets
288+
displayed in the results of a search::
287289

288290
$ beet ls -a forever -f "[$format] $album ($year) - $artist - $title"
289291
[MP3] For Emma, Forever Ago (2009) - Bon Iver - Flume

docs/guides/tagger.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,9 +268,10 @@ files, but can get confused when files don't have any metadata (or have wildly
268268
incorrect metadata). In this case, you need *acoustic fingerprinting*, a
269269
technology that identifies songs from the audio itself. With fingerprinting,
270270
beets can autotag files that have very bad or missing tags. The :doc:`"chroma"
271-
plugin </plugins/chroma>`, distributed with beets, uses the `Chromaprint`_ open-source fingerprinting technology, but it's disabled by default. That's because
272-
it's sort of tricky to install. See the :doc:`/plugins/chroma` page for a guide
273-
to getting it set up.
271+
plugin </plugins/chroma>`, distributed with beets, uses the `Chromaprint`_
272+
open-source fingerprinting technology, but it's disabled by default. That's
273+
because it's sort of tricky to install. See the :doc:`/plugins/chroma` page for
274+
a guide to getting it set up.
274275

275276
Before you jump into acoustic fingerprinting with both feet, though, give beets
276277
a try without it. You may be surprised at how well metadata-based matching

docs/plugins/acousticbrainz.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ As an alternative the `beets-xtractor`_ plugin can be used.
1010
.. _AcousticBrainz: https://acousticbrainz.org/
1111
.. _beets-xtractor: https://github.com/adamjakab/BeetsPluginXtractor
1212

13-
Enable the ``acousticbrainz`` plugin in your configuration (see :ref:`using-plugins`) and run it by typing::
13+
Enable the ``acousticbrainz`` plugin in your configuration (see
14+
:ref:`using-plugins`) and run it by typing::
1415

1516
$ beet acousticbrainz [-f] [QUERY]
1617

docs/plugins/albumtypes.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ With path formats configured like::
5353
comp: Various Artists/$album [$year]$atypes/...
5454

5555

56-
The default plugin configuration generates paths that look like this, for example::
56+
The default plugin configuration generates paths that look like this, for
57+
example::
5758

5859
Aphex Twin/[1993][EP][Remix] On Remixes
5960
Pink Floyd/[1995][Live] p·u·l·s·e

0 commit comments

Comments
 (0)