Skip to content

docs: use Google-style docstring for check_venom_ctx - #933

Draft
augmentcode[bot] wants to merge 1 commit into
mainfrom
michaelos443/check-venom-docstring-google-style
Draft

augmentcode[bot] wants to merge 1 commit into
mainfrom
michaelos443/check-venom-docstring-google-style

Conversation

@augmentcode

@augmentcode augmentcode Bot commented Jul 3, 2026

Copy link
Copy Markdown

Problem

  • Align check_venom_ctx's documentation with the requested Google docstring style.

Solution

  • Add a Google-style docstring that documents the context argument and the ExceptionGroup raised on semantic validation failures.

Misc

  • This was a manual session, but only github-app-api was available, so PR creation/comment attribution uses the bot identity.

Pull Request opened by Augment Code | View session

@augmentcode

augmentcode Bot commented Jul 3, 2026

Copy link
Copy Markdown
Author

PR Author Agent⚡

👋 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.

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deep Code Review Agent🐛

Review completed with 1 suggestions.

Fix in Cosmos



def check_venom_ctx(context: IRContext):
"""Validate a Venom IR context for semantic errors.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 👎

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Author Agent⚡

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.

@augmentcode

augmentcode Bot commented Jul 7, 2026

Copy link
Copy Markdown
Author

PR Author Agent⚡

This PR appears to be inactive. The agent will stop monitoring until a new comment is posted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant