Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: missing docstring for aupdate_state method #2435

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

YassinNouh21
Copy link

@YassinNouh21 YassinNouh21 commented Nov 16, 2024

Fixes #2207

Missing docstring for aupdate_state method

Description

Added proper docstring documentation for the aupdate_state method in the Pregel class. This enables mkdocstrings to properly generate API reference documentation.

Changes

  • Added Google-style docstring for aupdate_state method
  • Includes complete description, args, returns, raises sections
  • Matches style of other async method docstrings

Testing

  • No code changes, only documentation
  • Documentation builds correctly with mkdocs
  • API reference now shows aupdate_state method documentation

@YassinNouh21 YassinNouh21 changed the title Fixes #2207 - Missing docstring for aupdate_state method docs: missing docstring for aupdate_state method Nov 16, 2024
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.

DOC: In the github pages the aupdate_state is not documented
1 participant