Merge branch 'fix-shpinx-warnings' into 'master'

Fix sphinx warnings and include top-level tracetools_analysis docs

See merge request micro-ROS/ros_tracing/tracetools_analysis!73
This commit is contained in:
Christophe Bedard 2020-06-21 20:44:20 +00:00
commit 6863340afa
3 changed files with 4 additions and 2 deletions

View file

@ -1,6 +1,8 @@
tracetools_analysis tracetools_analysis
=================== ===================
.. automodule:: tracetools_analysis
loading loading
####### #######

View file

@ -495,7 +495,7 @@ class AutoProcessor():
Get applicable EventHandler instances for a list of events. Get applicable EventHandler instances for a list of events.
:param events: the 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) event_names = Processor.get_event_names(events)
# Force import of all processor submodules (i.e. files) so that we can find all # Force import of all processor submodules (i.e. files) so that we can find all

View file

@ -133,7 +133,7 @@ class Ros2DataModelUtil(DataModelUtil):
:param callback_obj: the callback object value :param callback_obj: the callback object value
:return: a dataframe containing the start timestamp (datetime) :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[ data = self.data.callback_instances.loc[
self.data.callback_instances.loc[:, 'callback_object'] == callback_obj, self.data.callback_instances.loc[:, 'callback_object'] == callback_obj,