Skip to content

Commit

Permalink
Merge pull request #4563 from JOJ0/playlist_docs
Browse files Browse the repository at this point in the history
Improve playlist plugin docs
  • Loading branch information
sampsyo authored Nov 30, 2022
2 parents 3077a3a + 6b06344 commit d7273bd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/plugins/playlist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ name::

$ beet ls playlist:anotherplaylist

A playlist query will use the paths found in the playlist file to match items
in the beets library. ``playlist:`` submits a regular beets
:ref:`query<queries>` similar to a :ref:`specific fields query<fieldsquery>`.
If you want the list in any particular order, you can use the standard beets
query syntax for :ref:`sorting<query-sort>`::

$ beet ls playlist:/path/to/someplaylist.m3u artist+ year+

Playlist queries do not reflect the original order in the m3u file.

The plugin can also update playlists in the playlist directory automatically
every time an item is moved or deleted. This can be controlled by the ``auto``
configuration option.
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/query.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _queries:

Queries
=======

Expand Down Expand Up @@ -50,6 +52,8 @@ will match both "The House of Tomorrow" by the Magnetic Fields, as well as
"Yesterday" by The Beatles. Note that the comma has to be followed by a space
(e.g., ``foo,bar`` will be treated as a single keyword, *not* as an OR-query).

.. _fieldsquery:

Specific Fields
---------------

Expand Down

0 comments on commit d7273bd

Please sign in to comment.