Add file docstrings

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

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

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

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
 

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
 

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',

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