Skip to content

Commit 842dd5a

Browse files
committed
Finish complete changelog pass
1 parent 550a6ef commit 842dd5a

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

docs/changelog.rst

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -400,12 +400,12 @@ For plugin developers:
400400
re-exports MediaFile at the old location for backwards-compatibility, but a
401401
deprecation warning is raised if you do this since we might drop this wrapper
402402
in a future release.
403-
* We've replaced beets' configuration library confit with a standalone
404-
version called `Confuse`_. Where you used to do
403+
* Similarly, we've replaced beets' configuration library (previously called
404+
Confit) with a standalone version called `Confuse`_. Where you used to do
405405
``from beets.util import confit``, now just do ``import confuse``. The code
406406
is almost identical apart from the name change. Again, we'll re-export at the
407407
old location (with a deprecation warning) for backwards compatibility, but
408-
might stop doing this in a future release.
408+
we might stop doing this in a future release.
409409
* ``beets.util.command_output`` now returns a named tuple containing both the
410410
standard output and the standard error data instead of just stdout alone.
411411
Client code will need to access the ``stdout`` attribute on the return
@@ -415,28 +415,25 @@ For plugin developers:
415415
* There were sporadic failures in ``test.test_player``. Hopefully these are
416416
fixed. If they resurface, please reopen the relevant issue.
417417
:bug:`3309` :bug:`3330`
418-
* The internal structure of the replaygain plugin had some changes: There are no
419-
longer separate R128 backend instances. Instead the targetlevel is passed to
420-
``compute_album_gain`` and ``compute_track_gain``.
421-
:bug:`3065`
422418
* The ``beets.plugins.MetadataSourcePlugin`` base class has been added to
423419
simplify development of plugins which query album, track, and search
424-
APIs to provide metadata matches for the importer. Refer to the Spotify and
425-
Deezer plugins for examples of using this template class.
420+
APIs to provide metadata matches for the importer. Refer to the
421+
:doc:`/plugins/spotify` and the :doc:`/plugins/deezer` for examples of using
422+
this template class.
426423
:bug:`3355`
427-
* The autotag hooks have been modified such that they now take 'bpm',
428-
'musical_key' and a per-track based 'genre' as attributes.
429-
* Item (and attribute) access on an item now falls back to the album's
430-
attributes as well. If you specifically want to access an item's attributes,
431-
use ``Item.get(key, with_album=False)``. :bug:`2988`
424+
* Accessing fields on an `Item` now falls back to the album's
425+
attributes. So, for example, ``item.foo`` will first look for a field `foo` on
426+
`item` and, if it doesn't exist, next tries looking for a field named `foo`
427+
on the album that contains `item`. If you specifically want to access an
428+
item's attributes, use ``Item.get(key, with_album=False)``. :bug:`2988`
432429
* ``Item.keys`` also has a ``with_album`` argument now, defaulting to ``True``.
433430
* A ``revision`` attribute has been added to ``Database``. It is increased on
434431
every transaction that mutates it. :bug:`2988`
435432
* The classes ``AlbumInfo`` and ``TrackInfo`` now convey arbitrary attributes
436433
instead of a fixed, built-in set of field names (which was important to
437434
address :bug:`1547`).
438435
Thanks to :user:`dosoe`.
439-
* Two new events, ``mb_album_extract`` and ``mb_track_extract``, let plugin
436+
* Two new events, ``mb_album_extract`` and ``mb_track_extract``, let plugins
440437
add new fields based on MusicBrainz data. Thanks to :user:`dosoe`.
441438

442439
For packagers:
@@ -445,7 +442,7 @@ For packagers:
445442
standalone project called `MediaFile`_, released as :pypi:`mediafile`. Beets
446443
now depends on this new package. Beets now depends on Mutagen transitively
447444
through MediaFile rather than directly, except in the case of one of beets'
448-
plugins (scrub).
445+
plugins (in particular, the :doc:`/plugins/scrub`).
449446
* Beets' library for configuration has been split into a standalone project
450447
called `Confuse`_, released as :pypi:`confuse`. Beets now depends on this
451448
package. Confuse has existed separately for some time and is used by
@@ -454,7 +451,7 @@ For packagers:
454451
or `repair <https://build.opensuse.org/package/view_file/openSUSE:Factory/beets/fix_test_command_line_option_relative_to_working_dir.diff?expand=1>`_
455452
the test may no longer be necessary.
456453
* This version drops support for Python 3.4.
457-
* Removes the optional dependency on bs1770gain.
454+
* We have removed an optional dependency on bs1770gain.
458455

459456
.. _Fish shell: https://fishshell.com/
460457
.. _MediaFile: https://github.com/beetbox/mediafile

0 commit comments

Comments
 (0)