docs: add documentation about the type ignore

eduNEXT · Aug 26, 2024 · 26fb79a · 26fb79a
1 parent f03da32
commit 26fb79a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tutorpicasso/commands/enable_themes.py b/tutorpicasso/commands/enable_themes.py
@@ -21,6 +21,9 @@ def enable_themes() -> None:
     if not tutor_conf.get("PICASSO_THEMES"):
         return
 
+    # We use `type: ignore` for the `tutor_conf` object
+    # because it comes from the Tutor framework.
+    # We are not handle type errors related to this object.
     for theme in tutor_conf["PICASSO_THEMES"]:  # type: ignore
         if not {"name", "repo", "version"}.issubset(theme.keys()):  # type: ignore
             raise click.ClickException(