Skip to content

Lot of doc fixes #2060

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 11 commits into from
Aug 24, 2020
Merged

Lot of doc fixes #2060

Bibo-Joshi merged 11 commits into from
Aug 24, 2020

Conversation

@harshil21
Copy link
Member

@harshil21 harshil21 commented Aug 21, 2020 •
edited
Loading

Doc fixes:

  • Doc fixes for most telegram classes. Also cross checked docs with official docs, except for some methods in bot.py.

  • Doc fixes for telegram.ext classes too.

  • Doc fixes for inline related classes still left (will do soon).

  • Doc fixes for payment, passport and game classes/files.

Also changed all ``True/False/None`` to :obj:`True/False/None` as requested.

@harshil21
Doc fixes for a few telegram.ext classes
374ee48
@harshil21
Doc fixes for most telegram classes.
5f9ea69
@harshil21
pep-8
cbc6bc8 
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
Bibo-Joshi
Bibo-Joshi requested changes Aug 21, 2020
View reviewed changes
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.

Hi. Thanks for the PR. You found quite a number of spelling mistakes :D
I left some comments for you.

@harshil21
Address review and made rendering of booleans consistent
765906f 
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
@harshil21
Few doc fixes for inline* classes
8daed53 
As usual, docs were cross-checked with official tg api docs.
@harshil21
Doc fixes for telegram/files classes
90f32c3 
As usual, docs were cross-checked with official tg api docs.
@harshil21
Doc fixes for telegram.Game
7dc67c1 
Mostly just added hyperlinks. And fixed message length doc.

As usual, docs were cross-checked with official tg api docs.
@harshil21
Very minor doc fix for passportfile.py and passportelementerrors.py
d46101a 
Didn't bother changing too much since this seems to be a custom implementation.
@harshil21
Doc fixes for telegram.payments
ff1b274 
As usual, cross-checked with official bot api docs.
@harshil21
Copy link
Member Author

harshil21 commented Aug 22, 2020

Okay, I've covered all telegram files except for those under utils. Done now, unless there's more changes requested.

@harshil21 harshil21 requested a review from Bibo-Joshi August 22, 2020 04:15
Bibo-Joshi
Bibo-Joshi requested changes Aug 22, 2020
View reviewed changes
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.

Thanks for the update! I left a bit more of nitpicking. Also if (and only if!) changing True to :obj:`True` (same for False and None) is realatively quickly done for you, that would be the cherry on top ;)

@harshil21
Copy link
Member Author

harshil21 commented Aug 22, 2020

Thanks for the update! I left a bit more of nitpicking. Also if (and only if!) changing True to :obj:`True` (same for False and None) is relatively quickly done for you, that would be the cherry on top ;)

Yea, I can do that. The main reasons I chose ``True`` over :obj:`True` is cause it gave more contrast (rendered in red rather than black) and that most telegram.Bot methods also had ``True``. So I thought that was the way to do it.

I'll switch it to :obj:`True/False/None` project wide then.

@harshil21 harshil21 requested a review from Bibo-Joshi August 24, 2020 00:24
@Bibo-Joshi Bibo-Joshi merged commit 078ac63 into python-telegram-bot:doc-fixes Aug 24, 2020
@Bibo-Joshi
Copy link
Member

Bibo-Joshi commented Aug 24, 2020

Thank you for your effort!

@harshil21 harshil21 deleted the doc-fixes branch August 24, 2020 17:55
@github-actions github-actions bot locked and limited conversation to collaborators Aug 26, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@Bibo-Joshi Bibo-Joshi Bibo-Joshi approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@harshil21 @Bibo-Joshi