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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add .. seealso doc sections in ApplicationBuilder. #3829

Merged

Conversation

aelkheir
Copy link
Contributor

@aelkheir aelkheir commented Aug 5, 2023

Closes #3825

  • Added .. versionadded:: NEXT.VERSION, .. versionchanged:: NEXT.VERSION or .. deprecated:: NEXT.VERSION to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
  • Created new or adapted existing unit tests
  • Documented code changes according to the CSI standard
  • Added myself alphabetically to AUTHORS.rst (optional)
  • Added new classes & modules to the docs and all suitable __all__ s
  • Checked the Stability Policy in case of deprecations or changes to documented behavior

Hi, did not wish for my first contribution to be docs 馃様. But I know they're just as important, so ..

Affected methods:

connect_timeout / get_updates_connect_timeout
connection_pool_size / get_updates_connection_pool_size
pool_timeout / get_updates_pool_timeout
read_timeout / get_updates_read_timeout
write_tiemout / get_updates_write_tiemout

Already documented correctely

proxy_url / get_updates_proxy_url
request / get_updates_requset
http_version / get_updates_http_version

Ran sphinx-build and the new See also sections seemed to be working fine.

I also added my self to the authors list. Thanks.

cross-references are added in `get_updates_*` methods and their
variants in `telegram.ext._applicationbuilder.ApplicationBuilder`.

Also adds @elkheir to AUTHORS.rst
Copy link
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution!

@harshil21 harshil21 merged commit 2c24c7b into python-telegram-bot:doc-fixes Aug 5, 2023
5 of 6 checks passed
@harshil21 harshil21 mentioned this pull request Aug 5, 2023
3 tasks
@aelkheir aelkheir deleted the seealso-appbuilder branch August 5, 2023 18:16
@github-actions github-actions bot locked and limited conversation to collaborators Aug 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants