Skip to content

Doc fixes #2404

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.

Sign up for GitHub

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

Jump to bottom
Merged
Bibo-Joshi merged 21 commits into from
Mar 14, 2021
Merged

Doc fixes #2404

Bibo-Joshi merged 21 commits into from
Mar 14, 2021

Conversation

@Bibo-Joshi
Copy link
Member

@Bibo-Joshi Bibo-Joshi commented Feb 28, 2021 •
edited
Loading

noteworthy changes:

  • Bump sphinx dependency. Reasoning: fix defaults #2363 tried to drop type annotations from the signatures in the docs, but that didn't have any effect, as the corresponding flag is new in sphinx v3.0 and RTD builds with v1.8.5 by default. So now the most recent version is pinned (pinning b/c that doesn't lead to surprises …). Also changes the setting from description to none, to avoid parameter lists being printed for the camelCase method aliases of Bot.
  • check why Returns, Return Type, Raises and Parameters are rendered differently than on master
  • Move ba04e5a to a standalone type hinting PR

@Bibo-Joshi Bibo-Joshi added the ⚙️ documentation affected functionality: documentation label Feb 28, 2021
@Bibo-Joshi Bibo-Joshi added this to the v13.4 milestone Feb 28, 2021
@Bibo-Joshi Telegram GithubBot Revised
Copy link
Member Author

Bibo-Joshi commented Mar 1, 2021

@Bibo-Joshi This branch is now also visible at https://python-telegram-bot.readthedocs.io/en/doc-fixes

github-actions[bot]
github-actions bot reviewed Mar 4, 2021
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hey! Looks like you edited README.rst or README_RAW.rst. I'm just a friendly reminder to apply relevant changes to both of those files :)

@Bibo-Joshi Bibo-Joshi merged commit 7d893fd into master Mar 14, 2021
This was referenced Mar 15, 2021
Closed
Merged
This was referenced Mar 15, 2021
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Merged
Closed
Closed
Closed
Closed
Closed
Closed
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Mar 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@Poolitzer Poolitzer Poolitzer approved these changes

Assignees

No one assigned

Labels

⚙️ documentation affected functionality: documentation

Projects

None yet

Milestone

v13.4

Development

Successfully merging this pull request may close these issues.

4 participants

@Bibo-Joshi @Poolitzer @harshil21