From 485ff6e31c39150d8acb1ccae0240fb03af5bd32 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Sun, 21 Jun 2020 16:35:19 -0400 Subject: [PATCH 1/2] Fix sphinx warnings Signed-off-by: Christophe Bedard --- tracetools_analysis/tracetools_analysis/processor/__init__.py | 2 +- tracetools_analysis/tracetools_analysis/utils/ros2.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tracetools_analysis/tracetools_analysis/processor/__init__.py b/tracetools_analysis/tracetools_analysis/processor/__init__.py index 380e970..c6c3921 100644 --- a/tracetools_analysis/tracetools_analysis/processor/__init__.py +++ b/tracetools_analysis/tracetools_analysis/processor/__init__.py @@ -495,7 +495,7 @@ class AutoProcessor(): Get applicable EventHandler instances for a list of events. :param events: the list of events - :return the concrete EventHandler instances which are applicable + :return: the concrete EventHandler instances which are applicable """ event_names = Processor.get_event_names(events) # Force import of all processor submodules (i.e. files) so that we can find all diff --git a/tracetools_analysis/tracetools_analysis/utils/ros2.py b/tracetools_analysis/tracetools_analysis/utils/ros2.py index 049ece4..b4934b9 100644 --- a/tracetools_analysis/tracetools_analysis/utils/ros2.py +++ b/tracetools_analysis/tracetools_analysis/utils/ros2.py @@ -133,7 +133,7 @@ class Ros2DataModelUtil(DataModelUtil): :param callback_obj: the callback object value :return: a dataframe containing the start timestamp (datetime) - and duration (ms) of all callback instances for that object + and duration (ms) of all callback instances for that object """ data = self.data.callback_instances.loc[ self.data.callback_instances.loc[:, 'callback_object'] == callback_obj, From 40bf4abeda74da3874c5f0318f4c0f85dbed2f90 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Sun, 21 Jun 2020 16:35:54 -0400 Subject: [PATCH 2/2] Include documentation from tracetools_analysis.__init__.py Signed-off-by: Christophe Bedard --- tracetools_analysis/docs/source/api/tracetools_analysis.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tracetools_analysis/docs/source/api/tracetools_analysis.rst b/tracetools_analysis/docs/source/api/tracetools_analysis.rst index f77b1bc..c935f6d 100644 --- a/tracetools_analysis/docs/source/api/tracetools_analysis.rst +++ b/tracetools_analysis/docs/source/api/tracetools_analysis.rst @@ -1,6 +1,8 @@ tracetools_analysis =================== +.. automodule:: tracetools_analysis + loading #######