Fixed some broken docstring references.

This commit is contained in:
Fabio Manganiello 2023-10-09 01:26:50 +02:00
parent 53bdcb9604
commit 1e93af86f4
Signed by untrusted user: blacklight
GPG key ID: D90FBA7F76362774
5 changed files with 10 additions and 10 deletions

View file

@ -34,7 +34,8 @@ class GoogleFitBackend(Backend):
"""
:param data_sources: Google Fit data source IDs to monitor. You can
get a list of the available data sources through the
:meth:`platypush.plugins.google.fit.get_data_sources` action
:meth:`platypush.plugins.google.fit.GoogleFitPlugin.get_data_sources`
action
:type data_sources: list[str]
:param user_id: Google user ID to track (default: 'me')

View file

@ -73,7 +73,7 @@ class CalendarIcalPlugin(Plugin, CalendarInterface):
def get_upcoming_events(self, *_, only_participating=True, **__):
"""
Get the upcoming events. See
:func:`~platypush.plugins.calendar.CalendarPlugin.get_upcoming_events`.
:meth:`platypush.plugins.calendar.CalendarPlugin.get_upcoming_events`.
"""
from icalendar import Calendar

View file

@ -49,7 +49,7 @@ class GoogleCalendarPlugin(GooglePlugin, CalendarInterface):
def get_upcoming_events(self, max_results=10):
"""
Get the upcoming events. See
:func:`~platypush.plugins.calendar.CalendarPlugin.get_upcoming_events`.
:meth:`platypush.plugins.calendar.CalendarPlugin.get_upcoming_events`.
"""
now = datetime.datetime.utcnow().isoformat() + 'Z'

View file

@ -245,7 +245,7 @@ class MediaMplayerPlugin(MediaPlugin):
"""
Execute a raw MPlayer command. See
https://www.mplayerhq.hu/DOCS/tech/slave.txt for a reference or call
:meth:`platypush.plugins.media.mplayer.list_actions` to get a list
:meth:`.list_actions` to get a list
"""
args = args or []

View file

@ -40,11 +40,11 @@ class SoundPlugin(RunnablePlugin):
):
"""
:param input_device: Index or name of the default input device. Use
:meth:`platypush.plugins.sound.query_devices` to get the
available devices. Default: system default
:meth:`.query_devices` to get the available devices. Default: system
default
:param output_device: Index or name of the default output device.
Use :meth:`platypush.plugins.sound.query_devices` to get the
available devices. Default: system default
Use :meth:`.query_devices` to get the available devices. Default:
system default
:param input_blocksize: Blocksize to be applied to the input device.
Try to increase this value if you get input overflow errors while
recording. Default: 1024
@ -160,8 +160,7 @@ class SoundPlugin(RunnablePlugin):
in the audio file in file mode, 1 if in synth mode
:param volume: Playback volume, between 0 and 100. Default: 100.
:param stream_index: If specified, play to an already active stream
index (you can get them through
:meth:`platypush.plugins.sound.query_streams`). Default:
index (you can get them through :meth:`.query_streams`). Default:
creates a new audio stream through PortAudio.
:param stream_name: Name of the stream to play to. If set, the sound
will be played to the specified stream name, or a stream with that