Fix linting

utiasDSL · Jan 13, 2025 · 48aae58 · 48aae58
1 parent 50359d8
commit 48aae58
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/lsy_drone_racing/envs/randomize.py b/lsy_drone_racing/envs/randomize.py
@@ -1,3 +1,10 @@
+"""Randomization functions for the simulation.
+
+The functions in this module are inserted (compiled) into the reset function of the simulation for
+efficiency. Because of this, they have to be functionally pure to work with JAX (see
+https://jax.readthedocs.io/en/latest/notebooks/Common_Gotchas_in_JAX.html#pure-functions).
+"""
+
 from typing import Callable
 
 import jax