- Include description comments at the beginning of each python example

- Unify description comments format
- Remove some unrequired lines

PythonAPI/examples/automatic_control.py

@@ -6,7 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
-"""Example of automatic vehicle control from client side."""
+"""Example of automatic vehicle control from client side, with a python defined agent"""
 
 from __future__ import print_function
 

PythonAPI/examples/draw_skeleton.py

@@ -5,6 +5,8 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
+"""Visualize the skeleton of a pedestrian"""
+
 import math
 import argparse
 import copy

PythonAPI/examples/interpolate_camera.py

@@ -1,15 +1,16 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2019 Computer Vision Center (CVC) at the Universitat Autonoma de
+# Copyright (c) 2024 Computer Vision Center (CVC) at the Universitat Autonoma de
 # Barcelona (UAB).
 #
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
+"""Smooth movement of a camera interpolating collection of keypoints provided in a xml file"""
+
 import argparse
 
 import numpy as np
-import matplotlib.pyplot as plt
 from scipy.interpolate import interp1d
 
 import xml.etree.ElementTree as ET

PythonAPI/examples/invertedai_traffic.py

@@ -6,9 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
-"""
-Example script to generate realistic traffic with the InvertedAI API
-"""
+"""Example script to generate realistic traffic with the InvertedAI API"""
 
 import os
 import time

PythonAPI/examples/lane_explorer.py

@@ -6,6 +6,8 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
+"""Sequentially visualize the opendrive points"""
+
 import carla
 
 import argparse

PythonAPI/examples/manual_control.py

@@ -6,8 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
-# Allows controlling a vehicle with a keyboard. For a simpler and more
-# documented example, please take a look at tutorial.py.
+"""Allows controlling a vehicle with a keyboard."""
 
 """
 Welcome to CARLA manual control.
@@ -57,10 +56,6 @@ Use ARROWS or WASD keys for control.
 from __future__ import print_function
 
 
-# ==============================================================================
-# -- find carla module ---------------------------------------------------------
-# ==============================================================================
-
 # ==============================================================================
 # -- imports -------------------------------------------------------------------
 # ==============================================================================

PythonAPI/examples/manual_control_with_traffic.py

@@ -6,8 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
-# Allows controlling a vehicle with a keyboard. For a simpler and more
-# documented example, please take a look at tutorial.py.
+"""Allows controlling a vehicle with a keyboard, generating traffic in the simulation"""
 
 """
 Welcome to CARLA manual control.

PythonAPI/examples/no_rendering_mode.py

@@ -6,7 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
-# Allows visualising a 2D map generated by vehicles.
+"""Allows visualising a 2D map generated by vehicles."""
 
 """
 Welcome to CARLA No-Rendering Mode Visualizer

PythonAPI/examples/recorder_replay.py

@@ -6,7 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
-"""Script that helps users to manually check a specific log"""
+"""Script that helps users to manually replay a log previously recorded"""
 
 import argparse
 import threading

PythonAPI/examples/vehicle_doors_demo.py

@@ -6,6 +6,8 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
+"""Example visualization of vehicle doors opening"""
+
 import argparse
 import math
 

PythonAPI/examples/vehicle_gallery.py

@@ -6,6 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
+"""Visualize the catalog of vehicles present in CARLA"""
 
 import carla
 

PythonAPI/examples/vehicle_lights_demo.py

@@ -11,6 +11,7 @@ import math
 
 import carla
 
+"""Visualize the different vehicle lights"""
 
 def get_transform(vehicle, angle, d=2.5):
 

PythonAPI/examples/visualize_radar.py

@@ -6,6 +6,7 @@
 # This work is licensed under the terms of the MIT license.
 # For a copy, see <https://opensource.org/licenses/MIT>.
 
+"""Visualize the radar data"""
 
 import argparse
 import math