Skip to content

Docs fixes #765

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

Merged
tsnoam merged 2 commits into from
Aug 2, 2017
Merged

Docs fixes #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ec22fc
Clean warnings during build_sphinx
tsnoam Aug 1, 2017
fe52624
fix documentation types
tsnoam Aug 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added docs/source/_static/.placeholder
View file
Open in desktop
Empty file.
2 changes: 1 addition & 1 deletion telegram/bot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,7 +616,7 @@ def send_video(self,
the Internet, or upload a new one using multipart/form-data. Lastly you can pass
an existing :class:`telegram.Video` object to send.
duration (:obj:`int`, optional): Duration of sent video in seconds.
width (Optional[int)): Video width.
width (:obj:`int`, optional): Video width.
height (:obj:`int`, optional): Video height.
caption (:obj:`str`, optional): Video caption (may also be used when resending videos
by file_id), 0-200 characters.
Expand Down
2 changes: 1 addition & 1 deletion telegram/callbackquery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class CallbackQuery(TelegramObject):

Note:
* In Python `from` is a reserved word, use `from_user` instead.
Exactly one of the fields :attr:`data` or :attr:`game_short_name` will be present.
* Exactly one of the fields :attr:`data` or :attr:`game_short_name` will be present.

Attributes:
id (:obj:`str`): Unique identifier for this query.
Expand Down
4 changes: 2 additions & 2 deletions telegram/ext/updater.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,8 @@ def start_webhook(self,
key (:obj:`str`, optional): Path to the SSL key file.
clean (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers
before actually starting the webhook. Default is ``False``.
bootstrap_retries (Optional[int[): Whether the bootstrapping phase of the `Updater`
will retry on failures on the Telegram server.
bootstrap_retries (:obj:`int`, optional): Whether the bootstrapping phase of the
`Updater` will retry on failures on the Telegram server.

* < 0 - retry indefinitely
* 0 - no retries (default)
Expand Down
30 changes: 15 additions & 15 deletions telegram/utils/request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,10 @@ def get(self, url, timeout=None):
"""Request an URL.

Args:
url (str): The web location we want to retrieve.
timeout (Optional[int|float]): If this value is specified, use it as the read timeout
from the server (instead of the one specified during creation of the connection
pool).
url (:obj:`str`): The web location we want to retrieve.
timeout (:obj:`int` | :obj:`float`): If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the
connection pool).

Returns:
A JSON object.
Expand All @@ -235,11 +235,11 @@ def get(self, url, timeout=None):
def post(self, url, data, timeout=None):
"""Request an URL.
Args:
url (str): The web location we want to retrieve.
url (:obj:`str`): The web location we want to retrieve.
data (dict[str, str|int]): A dict of key/value pairs. Note: On py2.7 value is unicode.
timeout (Optional[int|float]): If this value is specified, use it as the read timeout
from the server (instead of the one specified during creation of the connection
pool).
timeout (:obj:`int` | :obj:`float`): If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the
connection pool).

Returns:
A JSON object.
Expand Down Expand Up @@ -269,10 +269,10 @@ def retrieve(self, url, timeout=None):
"""Retrieve the contents of a file by its URL.

Args:
url (str): The web location we want to retrieve.
timeout (Optional[int|float]): If this value is specified, use it as the read timeout
from the server (instead of the one specified during creation of the connection
pool).
url (:obj:`str`): The web location we want to retrieve.
timeout (:obj:`int` | :obj:`float`): If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the
connection pool).

"""
urlopen_kwargs = {}
Expand All @@ -285,9 +285,9 @@ def download(self, url, filename, timeout=None):
"""Download a file by its URL.
Args:
url (str): The web location we want to retrieve.
timeout (Optional[int|float]): If this value is specified, use it as the read timeout
from the server (instead of the one specified during creation of the connection
pool).
timeout (:obj:`int` | :obj:`float`): If this value is specified, use it as the read
timeout from the server (instead of the one specified during creation of the
connection pool).

filename:
The filename within the path to download the file.
Expand Down