diff --git a/docs/changelog.rst b/docs/changelog.rst index 9ab397d0f..baf5d8e02 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -54,7 +54,7 @@ New features genres tag. - :doc:`plugins/ftintitle`: Added argument to skip the processing of artist and album artist are the same in ftintitle. -- :doc:`plugins/play`: Added `$playlist` marker to precisely edit the playlist +- :doc:`plugins/play`: Added ``$playlist`` marker to precisely edit the playlist filepath into the command calling the player program. - :doc:`plugins/lastgenre`: For tuning plugin settings ``-vvv`` can be passed to receive extra verbose logging around last.fm results and how they are @@ -63,13 +63,13 @@ New features - :doc:`plugins/importsource`: Added new plugin that tracks original import paths and optionally suggests removing source files when items are removed from the library. -- :doc:`plugins/mbpseudo`: Add a new `mbpseudo` plugin to proactively receive +- :doc:`plugins/mbpseudo`: Add a new ``mbpseudo`` plugin to proactively receive MusicBrainz pseudo-releases as recommendations during import. - Added support for Python 3.13. - :doc:`/plugins/convert`: ``force`` can be passed to override checks like no_convert, never_convert_lossy_files, same format, and max_bitrate -- :doc:`plugins/titlecase`: Add the `titlecase` plugin to allow users to resolve - differences in metadata source styles. +- :doc:`plugins/titlecase`: Add the ``titlecase`` plugin to allow users to + resolve differences in metadata source styles. - :doc:`plugins/spotify`: Added support for multi-artist albums and tracks, saving all contributing artists to the respective fields. - :doc:`plugins/fetchart`: Fix colorized output text. @@ -115,15 +115,15 @@ Bug fixes audio-features endpoint, the plugin logs a warning once and skips audio features for all remaining tracks in the session, avoiding unnecessary API calls and rate limit exhaustion. -- Running `beet --config config -e` now edits `` rather than - the default config path. :bug:`5652` +- Running ``beet --config config -e`` now edits ```` rather + than the default config path. :bug:`5652` - :doc:`plugins/lyrics`: Accepts strings for lyrics sources (previously only accepted a list of strings). :bug:`5962` - Fix a bug introduced in release 2.4.0 where import from any valid import-log-file always threw a "none of the paths are importable" error. -- :doc:`/plugins/web`: repair broken `/item/values/…` and `/albums/values/…` +- :doc:`/plugins/web`: repair broken ``/item/values/…`` and `/albums/values/…` endpoints. Previously, due to single-quotes (ie. string literal) in the SQL - query, the query eg. `GET /item/values/albumartist` would return the literal + query, the query eg. ``GET /item/values/albumartist`` would return the literal "albumartist" instead of a list of unique album artists. - Sanitize log messages by removing control characters preventing terminal rendering issues. @@ -194,7 +194,7 @@ Other changes - Finally removed gmusic plugin and all related code/docs as the Google Play Music service was shut down in 2020. - Updated color documentation with ``bright_*`` and ``bg_bright_*`` entries. -- Moved `beets/random.py` into `beetsplug/random.py` to cleanup core module. +- Moved ``beets/random.py`` into ``beetsplug/random.py`` to cleanup core module. - dbcore: Allow models to declare SQL indices; add an ``items.album_id`` index to speed up ``album.items()`` queries. :bug:`5809` @@ -252,12 +252,12 @@ New features - :doc:`plugins/discogs` Added support for featured artists. :bug:`6038` - :doc:`plugins/discogs` New configuration option :conf:`plugins.discogs:featured_string` to change the default string used to - join featured artists. The default string is `Feat.`. -- :doc:`plugins/discogs` Support for `artist_credit` in Discogs tags. + join featured artists. The default string is ``Feat.``. +- :doc:`plugins/discogs` Support for ``artist_credit`` in Discogs tags. :bug:`3354` - :doc:`plugins/discogs` Support for name variations and config options to specify where the variations are written. :bug:`3354` -- :doc:`plugins/web` Support for `nexttrack` keyboard press +- :doc:`plugins/web` Support for ``nexttrack`` keyboard press Bug fixes ~~~~~~~~~ @@ -271,8 +271,8 @@ Bug fixes problem occurred primarily when no album was provided or when the album field was an empty string. :bug:`5189` - :doc:`plugins/spotify` Removed old and undocumented config options - `artist_field`, `album_field` and `track` that were causing issues with track - matching. :bug:`5189` + ``artist_field``, ``album_field`` and ``track`` that were causing issues with + track matching. :bug:`5189` - :doc:`plugins/spotify` Fixed an issue where candidate lookup would not find matches due to query escaping (single vs double quotes). - :doc:`plugins/discogs` Fixed inconsistency in stripping disambiguation from diff --git a/docs/guides/main.rst b/docs/guides/main.rst index 48b248927..de49fecab 100644 --- a/docs/guides/main.rst +++ b/docs/guides/main.rst @@ -99,7 +99,7 @@ started. write: no # Don't modify tags 4. **Add customization via plugins (optional):** Beets comes with many plugins that extend its functionality. You can - enable plugins by adding a `plugins` section to your config file. + enable plugins by adding a ``plugins`` section to your config file. We recommend adding at least one :ref:`Autotagger Plugin ` to help with fetching metadata during import. diff --git a/docs/plugins/mbpseudo.rst b/docs/plugins/mbpseudo.rst index 56658db26..92d873422 100644 --- a/docs/plugins/mbpseudo.rst +++ b/docs/plugins/mbpseudo.rst @@ -1,7 +1,7 @@ MusicBrainz Pseudo-Release Plugin ================================= -The `mbpseudo` plugin can be used *instead of* the `musicbrainz` plugin to +The ``mbpseudo`` plugin can be used *instead of* the ``musicbrainz`` plugin to search for MusicBrainz pseudo-releases_ during the import process, which are added to the normal candidates from the MusicBrainz search. @@ -20,12 +20,12 @@ Configuration ------------- Since this plugin first searches for official releases from MusicBrainz, all -options from the `musicbrainz` plugin's :ref:`musicbrainz-config` are supported, -but they must be specified under `mbpseudo` in the configuration file. -Additionally, the configuration expects an array of scripts that are desired for -the pseudo-releases. For ``artist`` in particular, keep in mind that even -pseudo-releases might specify it with the original script, so you should also -configure import :ref:`languages` to give artist aliases more priority. +options from the ``musicbrainz`` plugin's :ref:`musicbrainz-config` are +supported, but they must be specified under ``mbpseudo`` in the configuration +file. Additionally, the configuration expects an array of scripts that are +desired for the pseudo-releases. For ``artist`` in particular, keep in mind that +even pseudo-releases might specify it with the original script, so you should +also configure import :ref:`languages` to give artist aliases more priority. Therefore, the minimum configuration for this plugin looks like this: .. code-block:: yaml @@ -39,10 +39,10 @@ Therefore, the minimum configuration for this plugin looks like this: scripts: - Latn -Note that the `search_limit` configuration applies to the initial search for -official releases, and that the `data_source` in the database will be -"MusicBrainz". Nevertheless, `data_source_mismatch_penalty` must also be -specified under `mbpseudo` if desired (see also +Note that the ``search_limit`` configuration applies to the initial search for +official releases, and that the ``data_source`` in the database will be +"MusicBrainz". Nevertheless, ``data_source_mismatch_penalty`` must also be +specified under ``mbpseudo`` if desired (see also :ref:`metadata-source-plugin-configuration`). An example with multiple data sources may look like this: diff --git a/docs/plugins/titlecase.rst b/docs/plugins/titlecase.rst index e2861f0ac..33dbe6534 100644 --- a/docs/plugins/titlecase.rst +++ b/docs/plugins/titlecase.rst @@ -145,7 +145,7 @@ Default :default: yes If a field name contains ``artist``, then any lowercase ``the`` will be - capitalized. Useful for bands with `The` as part of the proper name, + capitalized. Useful for bands with ``The`` as part of the proper name, like ``Amyl and The Sniffers``. .. conf:: all_caps