From 1e93af86f4f82cec50b7747487a1457fd7e5285e Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Mon, 9 Oct 2023 01:26:50 +0200 Subject: [PATCH] Fixed some broken docstring references. --- platypush/backend/google/fit/__init__.py | 3 ++- platypush/plugins/calendar/ical/__init__.py | 2 +- platypush/plugins/google/calendar/__init__.py | 2 +- platypush/plugins/media/mplayer/__init__.py | 2 +- platypush/plugins/sound/__init__.py | 11 +++++------ 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/platypush/backend/google/fit/__init__.py b/platypush/backend/google/fit/__init__.py index 523db0a8a8..0f0c327e6c 100644 --- a/platypush/backend/google/fit/__init__.py +++ b/platypush/backend/google/fit/__init__.py @@ -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') diff --git a/platypush/plugins/calendar/ical/__init__.py b/platypush/plugins/calendar/ical/__init__.py index c5a74c9332..184cc0c386 100644 --- a/platypush/plugins/calendar/ical/__init__.py +++ b/platypush/plugins/calendar/ical/__init__.py @@ -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 diff --git a/platypush/plugins/google/calendar/__init__.py b/platypush/plugins/google/calendar/__init__.py index 5f097eb774..665a5196cc 100644 --- a/platypush/plugins/google/calendar/__init__.py +++ b/platypush/plugins/google/calendar/__init__.py @@ -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' diff --git a/platypush/plugins/media/mplayer/__init__.py b/platypush/plugins/media/mplayer/__init__.py index 5e990accbc..414ae0cda6 100644 --- a/platypush/plugins/media/mplayer/__init__.py +++ b/platypush/plugins/media/mplayer/__init__.py @@ -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 [] diff --git a/platypush/plugins/sound/__init__.py b/platypush/plugins/sound/__init__.py index cb54f011da..d3fa12de08 100644 --- a/platypush/plugins/sound/__init__.py +++ b/platypush/plugins/sound/__init__.py @@ -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