Codegen: insert doc explaining _patch_class_qldoc

redsun82 · redsun82 · commit 369431125e11 · 2023-11-22T10:26:04.000+01:00
diff --git a/misc/codegen/generators/qlgen.py b/misc/codegen/generators/qlgen.py
@@ -323,6 +323,7 @@ def _get_stub(cls: schema.Class, base_import: str, generated_import_prefix: str)
 
 
 def _patch_class_qldoc(cls: str, qldoc: str, stub_file: pathlib.Path):
+    """ Replace or insert `qldoc` as the QLdoc of class `cls` in `stub_file` """
     if not qldoc or not stub_file.exists():
         return
     qldoc = "\n".join(l.rstrip() for l in qldoc.splitlines())
