fix(cli): prevent internal type annotations from leaking into help descriptions

[RinZ27]

PR Description

This PR addresses an issue in the ArgparseTranslator where internal Python type hints (such as Union[...], Optional[...], and Annotated[...]) were leaking into the CLI help messages from function docstrings. These annotations clutter the help output and can be confusing for end-users.

Key Changes

• Docstring Summary Isolation: Updated _build_description to strictly extract the function summary while stripping out redundant metadata sections like Parameters, Returns, and Examples which are already handled by argparse or are purely technical.
• Robust Type Cleaning: Enhanced the clean_type_annotation helper with more resilient regex patterns to handle varied spacing and nested type structures.
• User-Friendly Syntax: Ensured that pipe-style unions (int | str) and Union objects are consistently translated to human-readable "or" syntax (e.g., int or str).

Testing

• Verified locally that pytest cli/tests/test_argparse_translator.py passes.
• Manually confirmed that running CLI commands with --help now displays clean, concise descriptions without implementation details.

Potential Risks

• Low risk: These changes only affect the string transformation logic used for generating help messages and do not impact core command logic or argument parsing.

Review Guide

• Please review the regex patterns in the _build_description method to ensure they handle edge-case docstring indentations appropriately.

Best regards,
Rin

[CLAassistant]

All committers have signed the CLA.

[RinZ27]

Hi @deeleeramone, I've cleaned up the linting issue (minor whitespace on a blank line) and updated the branch. Could you please trigger the CI checks when you have a moment? Thanks!

[deeleeramone]

Thank you for identifying a problem and providing the solution.

[RinZ27]

It was a pleasure contributing to the project's security. I'm glad I could help make it a bit safer. Thank you for the smooth review process! @deeleeramone