Minor docs fixes

pixee · Nov 16, 2023 · 3c56324 · 3c56324
1 parent 72b8062
commit 3c56324
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/src/codemodder/scripts/generate_docs.py b/src/codemodder/scripts/generate_docs.py
@@ -179,6 +179,9 @@ def generate_docs(codemod):
     return output
 
 
+SKIP_DOCS = ["order-imports", "unused-imports"]
+
+
 def main():
     parser = argparse.ArgumentParser(
         description="Generate public docs for registered codemods."
@@ -192,7 +195,7 @@ def main():
 
     registry = load_registered_codemods()
     for codemod in registry.codemods:
-        if codemod.name == "order-imports":
+        if codemod.name in SKIP_DOCS:
             continue
 
         doc = generate_docs(codemod)

diff --git a/src/core_codemods/use_generator.py b/src/core_codemods/use_generator.py
@@ -6,7 +6,7 @@
 
 class UseGenerator(BaseCodemod, NameResolutionMixin):
     NAME = "use-generator"
-    SUMMARY = "Use generators for lazy evaluation"
+    SUMMARY = "Use Generator Expressions Instead of List Comprehensions"
     REVIEW_GUIDANCE = ReviewGuidance.MERGE_WITHOUT_REVIEW
     DESCRIPTION = "Replace list comprehension with generator expression"
     REFERENCES = [