Skip to content

Commit 8cef38a

Browse files
snejussnejus
committed
Reformat all docs using docstrfmt
1 parent 209963a commit 8cef38a

Some content is hidden

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

99 files changed

+6846
-7120
lines changed

‎docs/_templates/autosummary/class.rst

Lines changed: 3 additions & 3 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__

‎docs/api/database.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
Database
2-
--------
2+
========
33

44
.. currentmodule:: beets.library
55

6-
76
Library
8-
'''''''
7+
-------
98

109
.. autosummary::
1110
:toctree: generated/
1211

1312
Library
1413

15-
1614
Models
17-
''''''
15+
------
1816

1917
.. autosummary::
2018
:toctree: generated/
@@ -23,9 +21,8 @@ Models
2321
Album
2422
Item
2523

26-
2724
Transactions
28-
''''''''''''
25+
------------
2926

3027
.. currentmodule:: beets.dbcore.db
3128

@@ -35,7 +32,7 @@ Transactions
3532
Transaction
3633

3734
Queries
38-
'''''''
35+
-------
3936

4037
.. currentmodule:: beets.dbcore.query
4138

‎docs/api/plugins.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
Plugins
2-
-------
2+
=======
33

44
.. currentmodule:: beets.plugins
55

6-
7-
86
.. autosummary::
97
:toctree: generated/
108

‎docs/changelog.rst

Lines changed: 2770 additions & 3226 deletions
Large diffs are not rendered by default.

‎docs/code_of_conduct.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
.. code_of_conduct:
1+
..
2+
code_of_conduct:
23
34
.. include:: ../CODE_OF_CONDUCT.rst

‎docs/contributing.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
.. contributing:
1+
..
2+
contributing:
23
34
.. include:: ../CONTRIBUTING.rst

‎docs/dev/cli.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ Providing a CLI
22
===============
33

44
The ``beets.ui`` module houses interactions with the user via a terminal, the
5-
:doc:`/reference/cli`.
6-
The main function is called when the user types beet on the command line.
7-
The CLI functionality is organized into commands, some of which are built-in
8-
and some of which are provided by plugins. The built-in commands are all
9-
implemented in the ``beets.ui.commands`` submodule.
5+
:doc:`/reference/cli`. The main function is called when the user types beet on
6+
the command line. The CLI functionality is organized into commands, some of
7+
which are built-in and some of which are provided by plugins. The built-in
8+
commands are all implemented in the ``beets.ui.commands`` submodule.

‎docs/dev/importer.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ Music Importer
33

44
The importer component is responsible for the user-centric workflow that adds
55
music to a library. This is one of the first aspects that a user experiences
6-
when using beets: it finds music in the filesystem, groups it into albums,
7-
finds corresponding metadata in MusicBrainz, asks the user for intervention,
8-
applies changes, and moves/copies files. A description of its user interface is
9-
given in :doc:`/guides/tagger`.
6+
when using beets: it finds music in the filesystem, groups it into albums, finds
7+
corresponding metadata in MusicBrainz, asks the user for intervention, applies
8+
changes, and moves/copies files. A description of its user interface is given in
9+
:doc:`/guides/tagger`.
1010

11-
The workflow is implemented in the ``beets.importer`` module and is
12-
distinct from the core logic for matching MusicBrainz metadata (in the
13-
``beets.autotag`` module). The workflow is also decoupled from the command-line
14-
interface with the hope that, eventually, other (graphical) interfaces can be
15-
bolted onto the same importer implementation.
11+
The workflow is implemented in the ``beets.importer`` module and is distinct
12+
from the core logic for matching MusicBrainz metadata (in the ``beets.autotag``
13+
module). The workflow is also decoupled from the command-line interface with the
14+
hope that, eventually, other (graphical) interfaces can be bolted onto the same
15+
importer implementation.
1616

1717
The importer is multithreaded and follows the pipeline pattern. Each pipeline
18-
stage is a Python coroutine. The ``beets.util.pipeline`` module houses
19-
a generic, reusable implementation of a multithreaded pipeline.
18+
stage is a Python coroutine. The ``beets.util.pipeline`` module houses a
19+
generic, reusable implementation of a multithreaded pipeline.

‎docs/dev/index.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ For Developers
44
This section contains information for developers. Read on if you're interested
55
in hacking beets itself or creating plugins for it.
66

7-
See also the documentation for `MediaFile`_, the library used by beets to read
8-
and write metadata tags in media files.
7+
See also the documentation for MediaFile_, the library used by beets to read and
8+
write metadata tags in media files.
99

10-
.. _MediaFile: https://mediafile.readthedocs.io/en/latest/
10+
.. _mediafile: https://mediafile.readthedocs.io/en/latest/
1111

1212
.. toctree::
1313
:maxdepth: 1
@@ -17,11 +17,9 @@ and write metadata tags in media files.
1717
importer
1818
cli
1919

20-
2120
.. toctree::
2221
:maxdepth: 1
2322
:caption: API Reference
2423

2524
../api/plugins
2625
../api/database
27-

0 commit comments

Comments
 (0)