From 3c56324d834e53a8065dae6879f15a2a2f2426cd Mon Sep 17 00:00:00 2001 From: Daniel D'Avella Date: Thu, 16 Nov 2023 09:46:50 -0500 Subject: [PATCH] Minor docs fixes --- src/codemodder/scripts/generate_docs.py | 5 ++++- src/core_codemods/use_generator.py | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/codemodder/scripts/generate_docs.py b/src/codemodder/scripts/generate_docs.py index d333cb75..4f39cfb6 100644 --- 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 index e9b3839a..0a507db4 100644 --- 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 = [