Fix documentation & coding style of User.name & User.full_name #956
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Use string `format` instead of dict comprehension. - Better documentation to signify the semantics difference between `name` and `full_name`.
jsmnbom
approved these changes
Dec 30, 2017
|
Maybe note in docs that the username returned starts with '@'? |
|
@bomjacob Good idea. On it. |
|
@tsnoam I would remove the note. |
Codecov Report
@@ Coverage Diff @@
## master #956 +/- ##
==========================================
- Coverage 91.69% 91.68% -0.01%
==========================================
Files 103 103
Lines 4044 4042 -2
Branches 639 638 -1
==========================================
- Hits 3708 3706 -2
Misses 197 197
Partials 139 139
|
Eldinnie
requested changes
Dec 30, 2017
telegram/user.py
Outdated
| if present :attr:`first_name` and :attr:`last_name`. | ||
| :obj:`str`: The user's :attr:`username` if available, otherwise returns :attr:`full_name`. | ||
|
|
||
| NOTE: This is a convenience property, not part of the official Telegram Bot API. |
There was a problem hiding this comment.
Remove these notes please. We have them nowhere in the docs and it has no added value imo.
telegram/user.py
Outdated
| :obj:`str`: The users :attr:`first_name` and if present :attr:`last_name`. | ||
| :obj:`str`: The user's :attr:`first_name`, followed by (if present) :attr:`last_name`. | ||
|
|
||
| NOTE: This is a convenience property, not part of the official Telegram Bot API. |
There was a problem hiding this comment.
Remove these notes please. We have them nowhere in the docs and it has no added value imo.
Eldinnie
approved these changes
Dec 30, 2017
|
LGTM :) |
This was referenced Mar 2, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.