Skip to content

Feature/doc touch up - #1540

Open
AmboThom wants to merge 3 commits into
marketcalls:mainfrom
AmboThom:feature/doc-touch-up
Open

AmboThom wants to merge 3 commits into
marketcalls:mainfrom
AmboThom:feature/doc-touch-up

Conversation

@AmboThom

@AmboThom AmboThom commented Jun 17, 2026 •

Copy link
Copy Markdown

Summary

Added Google-style, PEP 257–compliant docstrings to run_async and get_webhook_secret in restx_api/telegram_bot.py to clarify usage, arguments, return values, and errors. Documentation-only change; no runtime behavior modified.

Closes #897
Changes Made

run_async(): replaced single-line docstring with full Google-style
docstring including Args, Returns, Raises, and Example sections

get_webhook_secret(): replaced two-line docstring with full Google-style
docstring including Returns, Raises, and Example sections

Testing

This change only updates documentation. No logic or behavior was altered, so new tests weren't necessary. I manually verified that both functions have full Google-style docstrings covering all required sections, and confirmed the rest of the file's code was left untouched.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

@AmboThom

Copy link
Copy Markdown
Author

Hi @marketcalls, I was wondering if there needs to be any changes.

This branch has not been deployed

No deployments
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.

python: Add comprehensive Google-style docstrings to telegram_bot.py helpers

1 participant