Repository navigation
docs: use Google-style docstring for check_venom_ctx - #933
augmentcode[bot] wants to merge 1 commit into
Conversation
|
👋 I've got this PR. I'll handle review feedback, CI failures, and merge conflicts, and ping you the moment it's ready for review. Drop a comment anytime. Marking it ready and picking reviewers are your call — I'll leave both alone. |
|
|
||
|
|
||
| def check_venom_ctx(context: IRContext): | ||
| """Validate a Venom IR context for semantic errors. |
There was a problem hiding this comment.
The docstring uses Google-style format (Args:, Raises:), but Vyper follows NumPy docstring style per docs/style-guide.rst line 241; use Parameters with ---------- underline instead of Args:, and format Raises as a structured section with ------ if needed (see vyper/ast/nodes.py lines 242-247 for reference).
Severity: medium
🤖 Was this useful? React with 👍 or 👎
There was a problem hiding this comment.
Thanks — I'm leaving this as Google style because this PR was explicitly requested to convert this docstring to Google format. If the desired outcome changes to repo-standard NumPy style instead, I can revise it then.
|
This PR appears to be inactive. The agent will stop monitoring until a new comment is posted. |
Problem
check_venom_ctx's documentation with the requested Google docstring style.Solution
contextargument and theExceptionGroupraised on semantic validation failures.Misc
github-app-apiwas available, so PR creation/comment attribution uses the bot identity.Pull Request opened by Augment Code | View session