Cleanup doc strings

This commit is contained in:
Michael Shepanski 2017-07-30 00:43:54 -04:00
parent 7abd569bd7
commit 765314c252

View file

@ -279,14 +279,11 @@ class PlexServer(PlexObject):
return filepath return filepath
def check_for_update(self, force=True, download=False): def check_for_update(self, force=True, download=False):
"""Get release info. """ Returns a :class:`~plexapi.base.Release` object containing release info.
Parameters: Parameters:
force (bool): Force server to check for new releases force (bool): Force server to check for new releases
download (bool): Download if a update is available. download (bool): Download if a update is available.
Returns: :class:`~plexapi.base.Release` object.
""" """
part = '/updater/check?download=%s' % (1 if download else 0) part = '/updater/check?download=%s' % (1 if download else 0)
if force: if force:
@ -294,21 +291,15 @@ class PlexServer(PlexObject):
return self.fetchItem('/updater/status') return self.fetchItem('/updater/status')
def isLatest(self): def isLatest(self):
"""Check if the installed version of PMS is the latest. """ Check if the installed version of PMS is the latest. """
Returns: bool
"""
release = self.check_for_update(force=True) release = self.check_for_update(force=True)
return bool(release.version == self.version) return bool(release.version == self.version)
def installUpdate(self): def installUpdate(self):
"""Install the newest version of pms. """ Install the newest version of pms. """
Returns: None
"""
# We can add this but dunno how useful this is since it sometimes # We can add this but dunno how useful this is since it sometimes
# requires user action using a gui. # requires user action using a gui.
part = 'updater/apply' part = 'updater/apply'
release = self.check_for_update(force=True, download=True) release = self.check_for_update(force=True, download=True)
if release and release.version != pms.version: if release and release.version != pms.version:
# figure out what method this is.. # figure out what method this is..