Merge pull request #1295 from kdelwat/docs/add-list-of-search-keys

docs: Add available search terms to LibraryController search
This commit is contained in:
Stein Magnus Jodal 2015-10-04 11:22:49 +02:00
commit 5abd541846

View File

@ -269,6 +269,9 @@ class LibraryController(object):
def search(self, query=None, uris=None, exact=False, **kwargs):
"""
Search the library for tracks where ``field`` contains ``values``.
``field`` can be one of ``uri``, ``track_name``, ``album``, ``artist``,
``albumartist``, ``composer``, ``performer``, ``track_no``, ``genre``,
``date``, ``comment`` or ``any``.
If ``uris`` is given, the search is limited to results from within the
URI roots. For example passing ``uris=['file:']`` will limit the search