From 578ef3bd023d33601e5c238e5cbb17ca4fb7612c Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Mon, 24 Jun 2019 10:53:27 +0200 Subject: [PATCH] Add function docstring --- ros2trace/ros2trace/api/__init__.py | 10 ++++++++++ tracetools_launch/tracetools_launch/trace.py | 9 ++++++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/ros2trace/ros2trace/api/__init__.py b/ros2trace/ros2trace/api/__init__.py index be9f07d..d39da83 100644 --- a/ros2trace/ros2trace/api/__init__.py +++ b/ros2trace/ros2trace/api/__init__.py @@ -25,6 +25,11 @@ def add_trace_arguments(parser): def init(args): + """ + Init and start tracing. + + :param args: the parsed arguments object containing the right fields + """ session_name = args.session_name base_path = args.path full_path = os.path.join(base_path, session_name) @@ -52,6 +57,11 @@ def init(args): def fini(args): + """ + Stop and finalize tracing. + + :param args: the parsed arguments object containing the right fields + """ session_name = args.session_name input('press enter to stop...') print('stopping & destroying tracing session') diff --git a/tracetools_launch/tracetools_launch/trace.py b/tracetools_launch/tracetools_launch/trace.py index d7d5b91..08da2f0 100644 --- a/tracetools_launch/tracetools_launch/trace.py +++ b/tracetools_launch/tracetools_launch/trace.py @@ -42,7 +42,14 @@ class Trace(Action): events_kernel: List[str] = names.DEFAULT_EVENTS_KERNEL, **kwargs, ) -> None: - """Constructor.""" + """ + Constructor. + + :param session_name: the name of the tracing session + :param base_path: the base directory in which to create the trace directory + :param events_ust: the list of ROS UST events to enable + :param events_kernel: the list of kernel events to enable + """ super().__init__(**kwargs) self.__session_name = session_name self.__path = os.path.join(base_path, session_name)