From dd8241cc1d628a84118685c9c766af52275d4f48 Mon Sep 17 00:00:00 2001
From: Christophe Bedard <fixed-term.christophe.bourquebedard@de.bosch.com>
Date: Mon, 24 Jun 2019 10:45:29 +0200
Subject: [PATCH] Add file docstrings

---
 ros2trace/ros2trace/api/__init__.py              | 2 ++
 ros2trace/ros2trace/command/trace.py             | 2 ++
 tracetools_launch/launch/example.launch.py       | 2 +-
 tracetools_trace/tracetools_trace/tools/args.py  | 2 ++
 tracetools_trace/tracetools_trace/tools/lttng.py | 2 +-
 tracetools_trace/tracetools_trace/tools/names.py | 2 +-
 tracetools_trace/tracetools_trace/trace.py       | 2 +-
 7 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/ros2trace/ros2trace/api/__init__.py b/ros2trace/ros2trace/api/__init__.py
index 73b2133..be9f07d 100644
--- a/ros2trace/ros2trace/api/__init__.py
+++ b/ros2trace/ros2trace/api/__init__.py
@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""API functions for the ROS 2 trace command."""
+
 import os
 
 from tracetools_trace.tools import args
diff --git a/ros2trace/ros2trace/command/trace.py b/ros2trace/ros2trace/command/trace.py
index 4e83304..07609c4 100644
--- a/ros2trace/ros2trace/command/trace.py
+++ b/ros2trace/ros2trace/command/trace.py
@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Module for trace command extension implementation."""
+
 from ros2cli.command import CommandExtension
 from ros2trace.api import add_trace_arguments
 from ros2trace.api import init
diff --git a/tracetools_launch/launch/example.launch.py b/tracetools_launch/launch/example.launch.py
index 267f1a2..325daa3 100644
--- a/tracetools_launch/launch/example.launch.py
+++ b/tracetools_launch/launch/example.launch.py
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Example launch file for the Trace action
+"""Example launch file for the Trace action."""
 
 from launch import LaunchDescription
 from launch_ros.actions import Node
diff --git a/tracetools_trace/tracetools_trace/tools/args.py b/tracetools_trace/tracetools_trace/tools/args.py
index 26818f3..09938ae 100644
--- a/tracetools_trace/tracetools_trace/tools/args.py
+++ b/tracetools_trace/tracetools_trace/tools/args.py
@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Module containing parsing functions for tracing commands."""
+
 import argparse
 import time
 
diff --git a/tracetools_trace/tracetools_trace/tools/lttng.py b/tracetools_trace/tracetools_trace/tools/lttng.py
index 079d7fe..21d4a83 100644
--- a/tracetools_trace/tracetools_trace/tools/lttng.py
+++ b/tracetools_trace/tracetools_trace/tools/lttng.py
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# LTTng tracing interface
+"""Interface for tracing with LTTng."""
 
 import sys
 
diff --git a/tracetools_trace/tracetools_trace/tools/names.py b/tracetools_trace/tracetools_trace/tools/names.py
index b293f53..d7469c9 100644
--- a/tracetools_trace/tracetools_trace/tools/names.py
+++ b/tracetools_trace/tracetools_trace/tools/names.py
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Lists of names (events, context)
+"""Lists of names (events, context) for tracing."""
 
 DEFAULT_EVENTS_KERNEL = [
     'block_rq_complete',
diff --git a/tracetools_trace/tracetools_trace/trace.py b/tracetools_trace/tracetools_trace/trace.py
index c4237af..055e63d 100644
--- a/tracetools_trace/tracetools_trace/trace.py
+++ b/tracetools_trace/tracetools_trace/trace.py
@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Entrypoint/script to setup and start an LTTng tracing session
+"""Entrypoint/script to setup and start an LTTng tracing session."""
 
 import os