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

[Documentation] bot.py doc fixes #1884

Merged
merged 5 commits into from
Apr 10, 2020
Merged

[Documentation] bot.py doc fixes #1884

merged 5 commits into from
Apr 10, 2020

Conversation

harshil21
Copy link
Member

All docs obtained from official Bot API docs.

All docs obtained from official Bot API docs
@harshil21
Copy link
Member Author

There is also documentation related to API 4.7 in there

@Bibo-Joshi Bibo-Joshi added the ⚙️ documentation affected functionality: documentation label Apr 9, 2020
@Bibo-Joshi
Copy link
Member

Wow, thanks! Will have to merge after #1858 though, if there is API 4.7 docs in there.
Also, flake8 is unhappy:

telegram/bot.py:506:100: E501 line too long (100 > 99 characters)

If you install the pre-commit hooks, git will check flake8 before commiting ;) see our contrib-guide

@Bibo-Joshi Bibo-Joshi added this to the 12.6 milestone Apr 9, 2020
@harshil21
Copy link
Member Author

Yea I didn't add all docs related to 4.7 since the new methods aren't there in bot.py yet.
Also I use GH desktop instead of git so that's why I can't run the tests before commiting :(

@Bibo-Joshi
Copy link
Member

Yea I didn't add all docs related to 4.7 since the new methods aren't there in bot.py yet.

I guessed so ;) But we'll release the API 4.7 changes soon.

Also I use GH desktop instead of git so that's why I can't run the tests before commiting :(

You only need a command line. Non-GUI stuff was scary to me at first, too, but it's worth it :)

Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

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

I did a bit of nitpicking ;)
Please build the docs on your local machine to make sure that everything renders correctly. See the contrib-guide for details on that (you're gonna have to use the command line for that …)

@harshil21
Copy link
Member Author

I did a bit of nitpicking ;)
Please build the docs on your local machine to make sure that everything renders correctly. See the contrib-guide for details on that (you're gonna have to use the command line for that …)

Yea I finally set up this command line thing and installed the pre-commit hooks. I'll now use it to render the docs too.

Also improved consistency of `returns:` in docs
@harshil21 harshil21 requested a review from Bibo-Joshi April 10, 2020 14:49
@Bibo-Joshi
Copy link
Member

CI fails unrelated (this is docs only). merging.

@Bibo-Joshi Bibo-Joshi merged commit 0a9f4bf into python-telegram-bot:master Apr 10, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 18, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
⚙️ documentation affected functionality: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants