chore: Update Usage Section to use example_pipelines.py (plural)

- example_pipelines.py, not example_pipeline.py, is the required
  filename

Signed-off-by: Giulio Frasca <[email protected]>

Author: gmfrasca

scripts/generate_readme/README.md

@@ -26,7 +26,7 @@ uv run python -m scripts.generate_readme --component components/some_category/my
 - **Google-style docstring parsing**: Extracts parameter descriptions and return values
 - **Custom content preservation**: Preserves user-added content after the `<!-- custom-content -->` marker
 - **Type annotation support**: Handles complex type annotations including Optional, Union, and generics
-- **Component-specific usage examples**: Includes/Updates an example usage for the given pipeline or component, if provided via `example_pipeline.py`
+- **Component-specific usage examples**: Includes/Updates an example usage for the given pipeline or component, if provided via `example_pipelines.py`
 
 ## Custom Content
 

scripts/generate_readme/README.md.j2

@@ -23,7 +23,7 @@
 {% endif %}
 
 {% if example_code %}
-## Usage Example 🧪
+## Usage Examples 🧪
 
 ```python
 {{ example_code }}

scripts/generate_readme/content_generator.py

@@ -23,7 +23,7 @@ def __init__(self, metadata: Dict[str, Any], source_dir: Path):
         self.metadata = metadata
         self.source_dir = source_dir
         self.metadata_file = source_dir / 'metadata.yaml'
-        self.example_file = source_dir / 'example_pipeline.py'
+        self.example_file = source_dir / 'example_pipelines.py'
         self.owners_file = source_dir / 'OWNERS'
         self.feature_metadata = self._load_feature_metadata()
 
@@ -81,7 +81,7 @@ def _load_owners(self) -> Dict[str, Any]:
                 return {}
         return {}
 
-    def _load_example_pipeline(self) -> str:
+    def _load_example_pipelines(self) -> str:
         """Load the Example Pipeline file if it exists.
 
         Returns:
@@ -92,7 +92,7 @@ def _load_example_pipeline(self) -> str:
                 with open(self.example_file, 'r', encoding='utf-8') as f:
                     return f.read()
             except Exception as e:
-                logger.warning(f"Error reading Example Pipeline file ({self.example_file}): {e}")
+                logger.warning(f"Error reading Example Pipelines file ({self.example_file}): {e}")
                 return ''
         return ''
 
@@ -244,7 +244,7 @@ def _prepare_template_context(self) -> Dict[str, Any]:
             }
 
         # Load example pipeline if it exists
-        example_code = self._load_example_pipeline()
+        example_code = self._load_example_pipelines()
 
         # Extract links for separate Additional Resources section (removes from feature_metadata)
         links = self.feature_metadata.pop('links', {})

scripts/generate_readme/tests/test_content_generator.py

@@ -207,7 +207,7 @@ def test_prepare_template_context(self, component_dir, sample_extracted_metadata
         assert context['title'] == 'Sample Component'
         assert context['component_name'] == 'sample_component'
 
-        # Check example_code is empty string when no example_pipeline.py exists
+        # Check example_code is empty string when no example_pipelines.py file exists
         assert context['example_code'] == ''
 
         # Check formatted metadata exists
@@ -296,17 +296,17 @@ def test_load_example_pipelines(self, component_dir, sample_extracted_metadata):
             component_dir
         )
 
-        # When no example_pipeline.py exists, should return empty string
-        example_code = generator._load_example_pipeline()
+        # When no example_pipelines.py exists, should return empty string
+        example_code = generator._load_example_pipelines()
         assert example_code == ''
 
-        # Create an example_pipeline.py file
-        example_file = component_dir / 'example_pipeline.py'
+        # Create an example_pipelines.py file
+        example_file = component_dir / 'example_pipelines.py'
         example_content = 'from kfp import dsl\n\n@dsl.pipeline()\ndef my_pipeline():\n    pass'
         example_file.write_text(example_content)
 
         # Now it should load the content
-        example_code = generator._load_example_pipeline()
+        example_code = generator._load_example_pipelines()
         assert example_code == example_content
 
     def test_generate_readme_component(self, component_dir, sample_extracted_metadata):
@@ -318,18 +318,18 @@ def test_generate_readme_component(self, component_dir, sample_extracted_metadat
 
         readme = generator.generate_readme()
 
-        # Check all sections are present (except Usage Example since no example_pipeline.py exists)
+        # Check all sections are present (except Usage Examples since no example_pipelines.py exists)
         assert '# Sample Component' in readme
         assert '## Overview' in readme
         assert '## Inputs' in readme
         assert '## Outputs' in readme
         assert '## Metadata' in readme
 
-        # Usage Example should NOT be present when example_pipeline.py doesn't exist
-        assert '## Usage Example' not in readme
+        # Usage Examples should NOT be present when example_pipelines.py doesn't exist
+        assert '## Usage Examples' not in readme
 
-        # Now test with example_pipeline.py present
-        example_file = component_dir / 'example_pipeline.py'
+        # Now test with example_pipelines.py present
+        example_file = component_dir / 'example_pipelines.py'
         example_file.write_text('from kfp import dsl\n\n@dsl.pipeline()\ndef test_pipeline():\n    pass')
 
         # Regenerate readme
@@ -339,8 +339,8 @@ def test_generate_readme_component(self, component_dir, sample_extracted_metadat
         )
         readme2 = generator2.generate_readme()
 
-        # Now Usage Example should be present
-        assert '## Usage Example' in readme2
+        # Now Usage Examples should be present
+        assert '## Usage Examples' in readme2
         assert 'from kfp import dsl' in readme2
 
     def test_generate_readme_pipeline(self, pipeline_dir, sample_extracted_metadata):
@@ -360,8 +360,8 @@ def test_generate_readme_pipeline(self, pipeline_dir, sample_extracted_metadata)
         assert '## Outputs' in readme
         assert '## Metadata' in readme
 
-        # Usage example should NOT be present for pipelines
-        assert '## Usage Example' not in readme
+        # Usage Examples should NOT be present for pipelines
+        assert '## Usage Examples' not in readme
 
     def test_generate_readme_empty_metadata(self, temp_dir):
         """Test README generation with empty metadata."""

scripts/generate_readme/tests/test_writer.py

@@ -108,8 +108,8 @@ def test_generate_component_readme(self, component_dir):
         assert "## Overview" in content
         assert "## Inputs" in content
         assert "## Outputs" in content
-        # Usage Example should NOT be present when example_pipeline.py doesn't exist
-        assert "## Usage Example" not in content
+        # Usage Examples should NOT be present when example_pipelines.py doesn't exist
+        assert "## Usage Examples" not in content
         assert "## Metadata" in content
 
     def test_generate_pipeline_readme(self, pipeline_dir):
@@ -127,7 +127,7 @@ def test_generate_pipeline_readme(self, pipeline_dir):
         content = readme_file.read_text()
         assert "# Sample Pipeline" in content
         assert "## Overview" in content
-        assert "## Usage Example" not in content  # Pipelines don't have usage examples
+        assert "## Usage Examples" not in content  # Pipelines don't have usage examples
 
     def test_generate_preserves_custom_content(self, component_dir):
         """Test that generation preserves custom content."""
@@ -254,14 +254,14 @@ def test_readme_format_is_markdown(self, component_dir):
         assert '|' in content  # Has tables
         assert '##' in content  # Has subheaders
 
-    def test_readme_with_example_pipeline(self, component_dir):
-        """Test that README includes usage example when example_pipeline.py exists."""
-        # Create example_pipeline.py file
-        example_file = component_dir / 'example_pipeline.py'
+    def test_readme_with_example_pipelines(self, component_dir):
+        """Test that README includes usage examples when example_pipelines.py exists."""
+        # Create example_pipelines.py file
+        example_file = component_dir / 'example_pipelines.py'
         example_content = '''from kfp import dsl
 from kubeflow.pipelines.components.components import sample_category
 
-@dsl.pipeline(name='example-pipeline')
+@dsl.pipeline(name='example-pipelines')
 def my_pipeline():
     sample_component_task = sample_category.sample_component(
         input_path="input.txt",
@@ -281,6 +281,6 @@ def my_pipeline():
 
         # Now code blocks should be present
         assert '```' in content  # Has code blocks
-        assert '## Usage Example' in content
+        assert '## Usage Examples' in content
         assert 'from kfp import dsl' in content