diff --git a/docs/changelog.rst b/docs/changelog.rst index 33ac9f65f..c95fefb81 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -27,10 +27,11 @@ For packagers: Other changes: -* Changed `bitesize` label to `good first issue`. Our - [contribute](https://github.com/beetbox/beets/contribute) page is now +* Changed `bitesize` label to `good first issue`. Our `contribute`_ page is now automatically populated with these issues. :bug:`4855` +.. _contribute: https://github.com/beetbox/beets/contribute + 2.1.0 (November 22, 2024) ------------------------- @@ -39,10 +40,10 @@ New features: * New template function added: ``%capitalize``. Converts the first letter of the text to uppercase and the rest to lowercase. * Ability to query albums with track db fields and vice-versa, for example - `beet list -a title:something` or `beet list artpath:cover`. Consequently - album queries involving `path` field have been sped up, like `beet list -a - path:/path/`. -* :doc:`plugins/ftintitle`: New `keep_in_artist` option for the plugin, which + ``beet list -a title:something`` or ``beet list artpath:cover``. Consequently + album queries involving ``path`` field have been sped up, like ``beet list -a + path:/path/``. +* :doc:`plugins/ftintitle`: New ``keep_in_artist`` option for the plugin, which allows keeping the "feat." part in the artist metadata while still changing the title. * :doc:`plugins/autobpm`: Add new configuration option ``beat_track_kwargs`` @@ -70,7 +71,7 @@ Bug fixes: issues in the future. :bug:`5289` * :doc:`plugins/discogs`: Fix the ``TypeError`` when there is no description. -* Remove single quotes from all SQL queries +* Use single quotes in all SQL queries :bug:`4709` * :doc:`plugins/lyrics`: Update ``tekstowo`` backend to fetch lyrics directly since recent updates to their website made it unsearchable. @@ -84,22 +85,22 @@ Bug fixes: For packagers: * The minimum supported Python version is now 3.8. -* The `beet` script has been removed from the repository. -* The `typing_extensions` is required for Python 3.10 and below. +* The ``beet`` script has been removed from the repository. +* The ``typing_extensions`` is required for Python 3.10 and below. Other changes: -* :doc:`contributing`: The project now uses `poetry` for packaging and +* :doc:`contributing`: The project now uses ``poetry`` for packaging and dependency management. This change affects project management and mostly affects beets developers. Please see updates in :ref:`getting-the-source` and :ref:`testing` for more information. -* :doc:`contributing`: Since `poetry` now manages local virtual environments, - `tox` has been replaced by a task runner `poethepoet`. This change affects +* :doc:`contributing`: Since ``poetry`` now manages local virtual environments, + `tox` has been replaced by a task runner ``poethepoet``. This change affects beets developers and contributors. Please see updates in the :ref:`development-tools` section for more details. Type ``poe`` while in the project directory to see the available commands. * Installation instructions have been made consistent across plugins - documentation. Users should simply install `beets` with an `extra` of the + documentation. Users should simply install ``beets`` with an ``extra`` of the corresponding plugin name in order to install extra dependencies for that plugin. * GitHub workflows have been reorganised for clarity: style, linting, type and @@ -110,10 +111,10 @@ Other changes: documentation is changed, and they only check the changed files. When dependencies are updated (``poetry.lock``), then the entire code base is checked. -* The long-deprecated `beets.util.confit` module has been removed. This may +* The long-deprecated ``beets.util.confit`` module has been removed. This may cause extremely outdated external plugins to fail to load. -* :doc:`plugins/autobpm`: Add plugin dependencies to `pyproject.toml` under - the `autobpm` extra and update the plugin installation instructions in the +* :doc:`plugins/autobpm`: Add plugin dependencies to ``pyproject.toml`` under + the ``autobpm`` extra and update the plugin installation instructions in the docs. Since importing the bpm calculation functionality from ``librosa`` takes around 4 seconds, update the plugin to only do so when it actually needs to