Psion-fanatic/platypush
1
0
Fork 0
forked from platypush/platypush
Code Pull requests Activity

Fixed some broken docstring references.

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

3
platypush/backend/google/fit/__init__.py
View file

@ -34,7 +34,8 @@ class GoogleFitBackend(Backend):
""" """
:param data_sources: Google Fit data source IDs to monitor. You can :param data_sources: Google Fit data source IDs to monitor. You can
get a list of the available data sources through the 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] :type data_sources: list[str]
:param user_id: Google user ID to track (default: 'me') :param user_id: Google user ID to track (default: 'me')

2
platypush/plugins/calendar/ical/__init__.py
View file

@ -73,7 +73,7 @@ class CalendarIcalPlugin(Plugin, CalendarInterface):
def get_upcoming_events(self, *_, only_participating=True, **__): def get_upcoming_events(self, *_, only_participating=True, **__):
""" """
Get the upcoming events. See 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 from icalendar import Calendar

2
platypush/plugins/google/calendar/__init__.py
View file

@ -49,7 +49,7 @@ class GoogleCalendarPlugin(GooglePlugin, CalendarInterface):
def get_upcoming_events(self, max_results=10): def get_upcoming_events(self, max_results=10):
""" """
Get the upcoming events. See 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' now = datetime.datetime.utcnow().isoformat() + 'Z'

2
platypush/plugins/media/mplayer/__init__.py
View file

@ -245,7 +245,7 @@ class MediaMplayerPlugin(MediaPlugin):
""" """
Execute a raw MPlayer command. See Execute a raw MPlayer command. See
https://www.mplayerhq.hu/DOCS/tech/slave.txt for a reference or call 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 [] args = args or []

11
platypush/plugins/sound/__init__.py
View file

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