Skip to content

Commit 86c722f

Browse files
committed
docstring updates
1 parent dc5d147 commit 86c722f

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

plexapi/base.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -430,12 +430,22 @@ def history(self, maxresults=9999999, mindate=None):
430430
return self._server.history(maxresults=maxresults, mindate=mindate, ratingKey=self.ratingKey)
431431

432432
def unmatch(self):
433-
""" Unmatches show object. """
433+
""" Unmatches metadata match from object. """
434434
key = '/library/metadata/%s/unmatch' % self.ratingKey
435435
self._server.query(key, method=self._server._session.put)
436436

437-
def matches(self, auto=True, agent=None, title=None, year=None, language=None):
438-
""" Return list of show metadata matches from library agent. """
437+
def matches(self, auto=False, agent=None, title=None, year=None, language=None):
438+
""" Return list of (:class:`~plexapi.media.SearchResult) metadata matches.
439+
440+
Parameters:
441+
auto (bool): True searches for matches automatically
442+
False allows for user to provide additional parameters to search
443+
*Auto searching
444+
agent (str): Agent name to be used (imdb, thetvdb, themoviedb, etc.)
445+
title (str): Title of item to search for
446+
year (str): Year of item to search in
447+
language (str) : Language of item to search in
448+
"""
439449
key = '/library/metadata/%s/matches' % self.ratingKey
440450
if not auto:
441451
params = {'manual': 1,

0 commit comments

Comments
 (0)