docs: Update docstring and changelog

This commit is contained in:
Thomas Adamcik 2015-03-31 00:01:34 +02:00
parent 887c0774fb
commit e2faf7f083
2 changed files with 24 additions and 6 deletions

View File

@ -5,6 +5,21 @@ Changelog
This changelog is used to track all major changes to Mopidy.
v1.1.0 (unreleased)
===================
Core API
--------
- Calling :meth:`mopidy.core.library.LibraryController.search`` with ``kwargs``
as the query is no longer supported (PR: :issue:`1090`)
Internal changes
----------------
- Tests have been cleaned up to stop using deprecated APIs where feasible.
(Partial fix: :issue:`1083`, PR: :issue:`1090`)
v1.0.0 (2015-03-25)
===================

View File

@ -209,12 +209,6 @@ class LibraryController(object):
"""
Search the library for tracks where ``field`` contains ``values``.
.. deprecated:: 1.0
Previously, if the query was empty, and the backend could support
it, all available tracks were returned. This has not changed, but
it is strongly discouraged. No new code should rely on this
behavior.
If ``uris`` is given, the search is limited to results from within the
URI roots. For example passing ``uris=['file:']`` will limit the search
to the local backend.
@ -247,6 +241,15 @@ class LibraryController(object):
.. versionadded:: 1.0
The ``exact`` keyword argument, which replaces :meth:`find_exact`.
.. deprecated:: 1.0
Previously, if the query was empty, and the backend could support
it, all available tracks were returned. This has not changed, but
it is strongly discouraged. No new code should rely on this
behavior.
.. deprecated:: 1.1
Providing the search query via ``kwargs`` is no longer supported.
"""
query = _normalize_query(query or kwargs)