[mauvilsa]

What does this PR do?

Adds support for parameter descriptions given as Annotated[..., Doc("...")] (PEP 727), e.g. using typing_extensions.Doc or any compatible Doc class that has a documentation attribute. The descriptions are shown in the help and take precedence over docstrings, so they work without the docstrings extra. This applies to functions, classes, dataclasses, pydantic models, TypedDicts and NamedTuples. The Doc metadata is removed from the type, while any other Annotated metadata is kept.

Before submitting

• Did you read the contributing guideline?
• If you used a coding agent, did you fully understand and validate all generated code and ensure it follows the contributing guidelines?
• Did you update the documentation? (readme and public docstrings)
• Did you write unit tests such that there is 100% coverage on related code? (required for bug fixes and new features)
• Did you verify that new and existing tests pass locally?
• [n/a] If this is a bug fix, did you verify that the tests fail without the code fix?
• Did you make sure that all changes preserve backward compatibility?
• Did you update the CHANGELOG including a pull request link? (not for typos, docs, test updates, or minor internal changes/refactors)

[greptile-apps]

Confidence Score: 4/5

[Medium impact] The PR changes generated parameter help across several supported input types.

The PR appears safe to merge, with two non-blocking gaps in how descriptions reach the help.

Findings

1.  Optional keys lose descriptions ▶
2.  Empty descriptions keep old text ▶

Summary

Adds parameter descriptions from Annotated[..., Doc("...")].

• Parameter help can use descriptions stored in Annotated metadata.

_{Reviews (1) · Last reviewed commit: "Support for parameter descriptions from ..." · Reviewed by Greptile}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6e80e2a) to head (1f4c59d).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #1030   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           27        27           
  Lines        10020     10046   +26     
=========================================
+ Hits         10020     10046   +26     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud