Docs: use double single quotes for raw strings

Author: snejus

docs/changelog.rst

@@ -151,50 +151,50 @@ registration process in this case::
 
 The events currently available are:
 
-* `pluginload`: called after all the plugins have been loaded after the ``beet``
-  command starts
+* ``pluginload``: called after all the plugins have been loaded after the
+  ``beet`` command starts
 
-* `import`: called after a ``beet import`` command finishes (the ``lib`` keyword
-  argument is a Library object; ``paths`` is a list of paths (strings) that were
-  imported)
+* ``import``: called after a ``beet import`` command finishes (the ``lib``
+  keyword argument is a Library object; ``paths`` is a list of paths (strings)
+  that were imported)
 
-* `album_imported`: called with an ``Album`` object every time the ``import``
+* ``album_imported``: called with an ``Album`` object every time the ``import``
   command finishes adding an album to the library. Parameters: ``lib``,
   ``album``
 
-* `album_removed`: called with an ``Album`` object every time an album is
+* ``album_removed``: called with an ``Album`` object every time an album is
   removed from the library (even when its file is not deleted from disk).
 
-* `item_copied`: called with an ``Item`` object whenever its file is copied.
+* ``item_copied``: called with an ``Item`` object whenever its file is copied.
   Parameters: ``item``, ``source`` path, ``destination`` path
 
-* `item_imported`: called with an ``Item`` object every time the importer adds a
-  singleton to the library (not called for full-album imports). Parameters:
-  ``lib``, ``item``
+* ``item_imported``: called with an ``Item`` object every time the importer
+  adds a singleton to the library (not called for full-album imports).
+  Parameters: ``lib``, ``item``
 
-* `before_item_moved`: called with an ``Item`` object immediately before its
+* ``before_item_moved``: called with an ``Item`` object immediately before its
   file is moved. Parameters: ``item``, ``source`` path, ``destination`` path
 
-* `item_moved`: called with an ``Item`` object whenever its file is moved.
+* ``item_moved``: called with an ``Item`` object whenever its file is moved.
   Parameters: ``item``, ``source`` path, ``destination`` path
 
-* `item_linked`: called with an ``Item`` object whenever a symlink is created
+* ``item_linked``: called with an ``Item`` object whenever a symlink is created
   for a file.
   Parameters: ``item``, ``source`` path, ``destination`` path
 
-* `item_hardlinked`: called with an ``Item`` object whenever a hardlink is
+* ``item_hardlinked``: called with an ``Item`` object whenever a hardlink is
   created for a file.
   Parameters: ``item``, ``source`` path, ``destination`` path
 
-* `item_reflinked`: called with an ``Item`` object whenever a reflink is
+* ``item_reflinked``: called with an ``Item`` object whenever a reflink is
   created for a file.
   Parameters: ``item``, ``source`` path, ``destination`` path
 
-* `item_removed`: called with an ``Item`` object every time an item (singleton
+* ``item_removed``: called with an ``Item`` object every time an item (singleton
   or album's part) is removed from the library (even when its file is not
   deleted from disk).
 
-* `write`: called with an ``Item`` object, a ``path``, and a ``tags``
+* ``write``: called with an ``Item`` object, a ``path``, and a ``tags``
   dictionary just before a file's metadata is written to disk (i.e.,
   just before the file on disk is opened). Event handlers may change
   the ``tags`` dictionary to customize the tags that are written to the
@@ -203,79 +203,80 @@ The events currently available are:
   operation. Beets will catch that exception, print an error message
   and continue.
 
-* `after_write`: called with an ``Item`` object after a file's metadata is
+* ``after_write``: called with an ``Item`` object after a file's metadata is
   written to disk (i.e., just after the file on disk is closed).
 
-* `import_task_created`: called immediately after an import task is
-  initialized. Plugins can use this to, for example, change imported files of a
-  task before anything else happens. It's also possible to replace the task
-  with another task by returning a list of tasks. This list can contain zero
-  or more `ImportTask`s. Returning an empty list will stop the task.
-  Parameters: ``task`` (an `ImportTask`) and ``session`` (an `ImportSession`).
+* ``import_task_created``: called immediately after an import task is
+  initialized. Plugins can use this to, for example, change imported files of
+  a task before anything else happens. It's also possible to replace the task
+  with another task by returning a list of tasks. This list can contain zero or
+  more ``ImportTask``. Returning an empty list will stop the task.
+  Parameters: ``task`` (an ``ImportTask``) and ``session`` (an
+  ``ImportSession``).
 
-* `import_task_start`: called when before an import task begins processing.
+* ``import_task_start``: called when before an import task begins processing.
   Parameters: ``task`` and ``session``.
 
-* `import_task_apply`: called after metadata changes have been applied in an
+* ``import_task_apply``: called after metadata changes have been applied in an
   import task. This is called on the same thread as the UI, so use this
   sparingly and only for tasks that can be done quickly. For most plugins, an
   import pipeline stage is a better choice (see :ref:`plugin-stage`).
   Parameters: ``task`` and ``session``.
 
-* `import_task_before_choice`: called after candidate search for an import task
-  before any decision is made about how/if to import or tag. Can be used to
-  present information about the task or initiate interaction with the user
+* ``import_task_before_choice``: called after candidate search for an import
+  task before any decision is made about how/if to import or tag. Can be used
+  to present information about the task or initiate interaction with the user
   before importing occurs. Return an importer action to take a specific action.
   Only one handler may return a non-None result.
   Parameters: ``task`` and ``session``
 
-* `import_task_choice`: called after a decision has been made about an import
+* ``import_task_choice``: called after a decision has been made about an import
   task. This event can be used to initiate further interaction with the user.
   Use ``task.choice_flag`` to determine or change the action to be
   taken. Parameters: ``task`` and ``session``.
 
-* `import_task_files`: called after an import task finishes manipulating the
+* ``import_task_files``: called after an import task finishes manipulating the
   filesystem (copying and moving files, writing metadata tags). Parameters:
   ``task`` and ``session``.
 
-* `library_opened`: called after beets starts up and initializes the main
+* ``library_opened``: called after beets starts up and initializes the main
   Library object. Parameter: ``lib``.
 
-* `database_change`: a modification has been made to the library database. The
+* ``database_change``: a modification has been made to the library database. The
   change might not be committed yet. Parameters: ``lib`` and ``model``.
 
-* `cli_exit`: called just before the ``beet`` command-line program exits.
+* ``cli_exit``: called just before the ``beet`` command-line program exits.
   Parameter: ``lib``.
 
-* `import_begin`: called just before a ``beet import`` session starts up.
+* ``import_begin``: called just before a ``beet import`` session starts up.
   Parameter: ``session``.
 
-* `trackinfo_received`: called after metadata for a track item has been
+* ``trackinfo_received``: called after metadata for a track item has been
   fetched from a data source, such as MusicBrainz. You can modify the tags
   that the rest of the pipeline sees on a ``beet import`` operation or during
   later adjustments, such as ``mbsync``. Slow handlers of the event can impact
   the operation, since the event is fired for any fetched possible match
-  `before` the user (or the autotagger machinery) gets to see the match.
+  ``before`` the user (or the autotagger machinery) gets to see the match.
   Parameter: ``info``.
 
-* `albuminfo_received`: like `trackinfo_received`, the event indicates new
+* ``albuminfo_received``: like ``trackinfo_received``, the event indicates new
   metadata for album items. The parameter is an ``AlbumInfo`` object instead
   of a ``TrackInfo``.
   Parameter: ``info``.
 
-* `before_choose_candidate`: called before the user is prompted for a decision
+* ``before_choose_candidate``: called before the user is prompted for a decision
   during a ``beet import`` interactive session. Plugins can use this event for
   :ref:`appending choices to the prompt <append_prompt_choices>` by returning a
   list of ``PromptChoices``. Parameters: ``task`` and ``session``.
-* `mb_track_extract`: called after the metadata is obtained from MusicBrainz.
+* ``mb_track_extract``: called after the metadata is obtained from MusicBrainz.
   The parameter is a ``dict`` containing the tags retrieved from MusicBrainz for
   a track. Plugins must return a new (potentially empty) ``dict`` with
   additional ``field: value`` pairs, which the autotagger will apply to the
   item, as flexible attributes if ``field`` is not a hardcoded field. Fields
   already present on the track are overwritten. Parameter: ``data``
-* `mb_album_extract`: Like `mb_track_extract`, but for album tags. Overwrites
-  tags set at the track level, if they have the same ``field``. Parameter:
-  ``data``
+* ``mb_album_extract``: Like ``mb_track_extract``, but for album tags.
+  Overwrites tags set at the track level, if they have the same ``field``.
+  Parameter: ``data``
 
 The included ``mpdupdate`` plugin provides an example use case for event
 listeners.
@@ -328,10 +329,10 @@ Read Configuration Options
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Plugins can configure themselves using the ``config.yaml`` file. You can read
-configuration values in two ways. The first is to use `self.config` within
+configuration values in two ways. The first is to use ``self.config`` within
 your plugin class. This gives you a view onto the configuration values in a
 section with the same name as your plugin's module. For example, if your plugin
-is in ``greatplugin.py``, then `self.config` will refer to options under the
+is in ``greatplugin.py``, then ``self.config`` will refer to options under the
 ``greatplugin:`` section of the config file.
 
 For example, if you have a configuration value called "foo", then users can put
@@ -341,19 +342,19 @@ this in their ``config.yaml``::
         foo: bar
 
 To access this value, say ``self.config['foo'].get()`` at any point in your
-plugin's code. The `self.config` object is a *view* as defined by the `Confuse`_
-library.
+plugin's code. The ``self.config`` object is a *view* as defined by the
+`Confuse`_ library.
 
 .. _Confuse: https://confuse.readthedocs.io/en/latest/
 
 If you want to access configuration values *outside* of your plugin's section,
-import the `config` object from the `beets` module. That is, just put ``from
+import the ``config`` object from the ``beets`` module. That is, just put ``from
 beets import config`` at the top of your plugin and access values from there.
 
 If your plugin provides configuration values for sensitive data (e.g.,
 passwords, API keys, ...), you should add these to the config so they can be
 redacted automatically when users dump their config. This can be done by
-setting each value's `redact` flag, like so::
+setting each value's ``redact`` flag, like so::
 
     self.config['password'].redact = True
 
@@ -541,11 +542,11 @@ should have an integer type::
         def album_types(self):
             return {'rating': types.INTEGER}
 
-A plugin may define two attributes: `item_types` and `album_types`.
+A plugin may define two attributes: ``item_types`` and ``album_types``.
 Each of those attributes is a dictionary mapping a flexible field name
 to a type instance. You can find the built-in types in the
-`beets.dbcore.types` and `beets.library` modules or implement your own
-type by inheriting from the `Type` class.
+``beets.dbcore.types`` and ``beets.library`` modules or implement your own
+type by inheriting from the ``Type`` class.
 
 Specifying types has several advantages:
 

docs/dev/plugins.rst

@@ -291,7 +291,7 @@ displayed in the results of a search::
     [MP3] For Emma, Forever Ago (2009) - Bon Iver - Flume
     [AAC] Freezepop Forever (2011) - Freezepop - Harebrained Scheme
 
-In the format option, field references like `$format` and `$year` are filled
+In the format option, field references like ``$format`` and ``$year`` are filled
 in with data from each result. You can see a full list of available fields by
 running ``beet fields``.
 

docs/guides/main.rst

@@ -1,8 +1,8 @@
 AutoBPM Plugin
 ==============
 
-The `autobpm` plugin uses the `Librosa`_ library to calculate the BPM
-of a track from its audio data and store it in the `bpm` field of your
+The ``autobpm`` plugin uses the `Librosa`_ library to calculate the BPM
+of a track from its audio data and store it in the ``bpm`` field of your
 database. It does so automatically when importing music or through
 the ``beet autobpm [QUERY]`` command.
 
@@ -26,7 +26,7 @@ configuration file. The available options are:
   Otherwise, you need to use the ``beet autobpm`` command explicitly.
   Default: ``yes``
 - **overwrite**: Calculate a BPM even for files that already have a
-  `bpm` value.
+  ``bpm`` value.
   Default: ``no``.
 - **beat_track_kwargs**: Any extra keyword arguments that you would like to
   provide to librosa's `beat_track`_ function call, for example:

docs/plugins/autobpm.rst

@@ -26,7 +26,7 @@ Custom commands will be run once for each file of the specified type, with the
 path to the file as the last argument. Commands must return a status code
 greater than zero for a file to be considered corrupt.
 
-You can run the checkers when importing files by using the `check_on_import`
+You can run the checkers when importing files by using the ``check_on_import``
 option. When on, checkers will be run against every imported file and warnings
 and errors will be presented when selecting a tagging option.
 

docs/plugins/badfiles.rst

@@ -52,7 +52,7 @@ The available options are:
   fields.
   Default: none.
 - **bucket_alpha_regex**: A ``range: regex`` mapping (one per line) where
-  ``range`` is one of the `bucket_alpha` ranges and ``value`` is  a regex that
+  ``range`` is one of the ``bucket_alpha`` ranges and ``value`` is  a regex that
   overrides original range definition.
   Default: none.
 - **bucket_year**: Ranges to use for all substitutions occurring on the
@@ -72,6 +72,6 @@ Here's an example::
          bucket_alpha_regex:
            'A - D': ^[0-9a-dA-D…äÄ]
 
-This configuration creates five-year ranges for any input year. The `A - D`
+This configuration creates five-year ranges for any input year. The ``A - D``
 bucket now matches also all artists starting with ä or Ä and 0 to 9 and …
 (ellipsis). The other alpha buckets work as ranges.

docs/plugins/bucket.rst

@@ -84,7 +84,7 @@ file. The available options are:
   defined in your config file.
   Default: ``no``.
 
-  .. note:: You probably want to use only one of the `auto` and `auto_keep`
+  .. note:: You probably want to use only one of the ``auto`` and ``auto_keep``
      options, not both. Enabling both will convert your files twice on import,
      which you probably don't want.
 
@@ -142,7 +142,7 @@ file. The available options are:
   after the transcoding step has completed.
   Default: ``false``.
 - **playlist**: The name of a playlist file that should be written on each run
-  of the plugin. A relative file path (e.g `playlists/mylist.m3u8`) is allowed
+  of the plugin. A relative file path (e.g ``playlists/mylist.m3u8``) is allowed
   as well. The final destination of the playlist file will always be relative
   to the destination path (``dest``, ``--dest``, ``-d``). This configuration is
   overridden by the ``-m`` (``--playlist``) command line option.
@@ -177,7 +177,7 @@ and select a command with the ``--format`` command-line option or the
             wav: ffmpeg -i $source -y -acodec pcm_s16le $dest
 
 In this example ``beet convert`` will use the *speex* command by
-default. To convert the audio to `wav`, run ``beet convert -f wav``.
+default. To convert the audio to ``wav``, run ``beet convert -f wav``.
 This will also use the format key (``wav``) as the file extension.
 
 Each entry in the ``formats`` map consists of a key (the name of the
@@ -189,7 +189,7 @@ command to use to transcode audio. The tokens ``$source`` and ``$dest`` in the
 command are replaced with the paths to the existing and new file.
 
 The plugin in comes with default commands for the most common audio
-formats: `mp3`, `alac`, `flac`, `aac`, `opus`, `ogg`, `wma`. For
+formats: ``mp3``, ``alac``, ``flac``, ``aac``, ``opus``, ``ogg``, ``wma``. For
 details have a look at the output of ``beet config -d``.
 
 For a one-command-fits-all solution use the ``convert.command`` and

docs/plugins/convert.rst

@@ -64,7 +64,7 @@ key:
 
 - **delimiter**: Used as the separating character between fields. The default
   value is a comma (,).
-- **dialect**: The kind of CSV file to produce. The default is `excel`.
+- **dialect**: The kind of CSV file to produce. The default is ``excel``.
 
 These options match the options from the `Python csv module`_.
 

docs/plugins/export.rst

@@ -63,7 +63,7 @@ file. The available options are:
   still be considered valid. This can be done either in pixels
   (``enforce_ratio: 10px``) or as a percentage of the longer edge
   (``enforce_ratio: 0.5%``). Default: ``no``.
-- **sources**: List of sources to search for images. An asterisk `*` expands
+- **sources**: List of sources to search for images. An asterisk ``*`` expands
   to all available sources.
   Default: ``filesystem coverart itunes amazon albumart``, i.e., everything but
   ``wikipedia``, ``google``, ``fanarttv`` and ``lastfm``. Enable those sources
@@ -268,19 +268,19 @@ Spotify album id is found.
 Cover Art URL
 '''''''''''''
 
-The `fetchart` plugin can also use a flexible attribute field ``cover_art_url``
-where you can manually specify the image URL to be used as cover art. Any custom
-plugin can use this field to provide the cover art and ``fetchart`` will use it
-as a source.
+The ``fetchart`` plugin can also use a flexible attribute field
+``cover_art_url`` where you can manually specify the image URL to be used as
+cover art. Any custom plugin can use this field to provide the cover art and
+``fetchart`` will use it as a source.
 
 .. _cover-art-archive-maxwidth:
 
 Cover Art Archive Pre-sized Thumbnails
 --------------------------------------
 
 The CAA provides pre-sized thumbnails of width 250, 500, and 1200 pixels. If you
-set the `maxwidth` option to one of these values, the corresponding image will
-be downloaded, saving `beets` the need to scale down the image. It can also
+set the ``maxwidth`` option to one of these values, the corresponding image will
+be downloaded, saving ``beets`` the need to scale down the image. It can also
 speed up the downloading process, as some cover arts can sometimes be very
 large.
 

docs/plugins/fetchart.rst

@@ -212,7 +212,7 @@ Metadata
 
 :doc:`importadded <importadded>`
    Use file modification times for guessing the value for
-   the `added` field in the database.
+   the ``added`` field in the database.
 
 :doc:`lastgenre <lastgenre>`
    Fetch genres based on Last.fm tags.
@@ -484,7 +484,7 @@ Here are a few of the plugins written by the beets community:
 
 `beets-filetote`_
    Helps bring non-music extra files, attachments, and artifacts during
-   imports and CLI file manipulation actions (`beet move`, etc.).
+   imports and CLI file manipulation actions (``beet move``, etc.).
 
 `beets-follow`_
    Lets you check for new albums from artists you like.