Skip to content

fix(pipelines-components): improve title casing in AutoML and AutoRAG component README's - #196

Open
mateusz-szewczyk-dev wants to merge 1 commit into
kubeflow:mainfrom
mateusz-szewczyk-dev:fix-RHOAIENG-94939
Open

mateusz-szewczyk-dev wants to merge 1 commit into
kubeflow:mainfrom
mateusz-szewczyk-dev:fix-RHOAIENG-94939

Conversation

@mateusz-szewczyk-dev

Copy link
Copy Markdown
Contributor

Description of your changes:

Summary

  • Replaced the hardcoded acronym list in format_title() with a SPECIAL_CASE_WORDS mapping in constants.py, adding support for AutoML and AutoRAG alongside the existing KFP, API, URL, ID, UI, CI, CD cases.
  • Moved wrap_text() from content_generator.py to utils.py and removed the leftover duplicate definition that remained in content_generator.py after the move; it now imports wrap_text() from utils.py alongside format_title().
  • Minor formatting fixes: normalized spacing around an operator in yoda_data_processor/component.py and unwrapped a warning message onto a single line in validate_examples.py.

Why

wrap_text() is a general text-formatting helper, not README-content-generation logic, so it belongs in utils.py alongside format_title() rather than in content_generator.py. Completing the move (removing the stray duplicate) keeps a single source of truth. Moving the special-case word list to constants.py also makes it easier to extend without touching function logic.

Checklist:

Pre-Submission Checklist

Additional Checklist Items for New or Updated Components/Pipelines

  • metadata.yaml includes fresh lastVerified timestamp
  • All required files
    are present and complete
  • OWNERS file lists appropriate maintainers
  • README provides clear documentation with usage examples
  • Component follows snake_case naming convention
  • No security vulnerabilities in dependencies
  • Containerfile included if using a custom base image

…text

Signed-off-by: Mateusz Szewczyk <mszewczy@redhat.com>
@google-oss-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign hbelmiro for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant