Add documentation for supported docstring formats#640
Add documentation for supported docstring formats#640emmett-walsh wants to merge 1 commit intogoogle:masterfrom
Conversation
Documents the three supported docstring formats (Google, NumPy, and RST) and their behavior differences when generating help text. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Ok so it looks like the email that Claude uses for co-signing commits doesn't have a CLA. I suppose I could open a new PR without the co-signed commit but I don't want to 'sneak' past the licence checks if that's a no-go. Do y'all have a policy on this? |
Summary
Adds a new "Documenting your CLI" section to the CLI usage guide that documents the three supported docstring formats and their behavior differences, closing #237
As you'll see below this change was made with the assistance of Claude Code; I couldn't find any explicit guidance on if this is permitted on this project or not so please let me know
Changes
docs/using-cli.mdContext
Testing showed that:
Type:for arguments when type annotations are present🤖 Generated with Claude Code