Documentation for every changed function, one click away. CloudAEye writes docstrings for undocumented code in an open pull request and posts them as review suggestions you can apply.
Generate docstrings for undocumented code in an open pull request and post them as review suggestions. Reports which suggestions were generated and which reached the PR.
acme/orders-api #412
On the pull request
src/billing/refund.pySuggested change
def apply_refund(order, amount):
"""Refund part or all of a paid order.
Args:
order: The paid order to refund.
amount: The amount to refund, in the order's currency.
Raises:
ValueError: If amount exceeds the remaining balance.
""" balance = order.total - order.refundedRead it, then apply it with one click.
In your coding agent
/cloudaeye:add-docs #4129 docstrings proposed
| File | Suggestions |
|---|---|
src/billing/refund.py |
4 |
src/billing/invoice.py |
3 |
src/billing/__init__.py |
2 |
7 posted as one-click suggestions, 2 as comments.
Lines outside the PR's diff cannot take a suggestion, so those go up as plain comments. Both numbers are reported.
Undocumented functions are a reviewer's first comment. CloudAEye writes the docstrings for the code a pull request touches, and you decide what to apply.
CloudAEye reads the code graph, not just the diff, to find changed functions and classes without a docstring, and writes each one in your repository's style.
The report shows how many docstrings were generated and how many reached the pull request, so nothing is rounded up.
Your coding agent confirms before posting, and the generated text stays on the pull request instead of passing through the agent's context.
Run it after the PR checklist reports docstring coverage failing, and close the gap without writing each docstring by hand.
Claude Code
/cloudaeye:add-docs #412
Codex
$cloudaeye:add-docs #412
@cloudaeye /add_docs