Add missing docs utils #912
Merged
Conversation
This file contains hidden or 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
Member
|
Can we add the docs modification needed for Filters.status_update.new_chat_members in here? There's a place were it;s missing an s if i'm not mistaken? |
Eldinnie
requested changes
Dec 5, 2017
Member
Eldinnie
left a comment
There was a problem hiding this comment.
I left some comments. Some are debatable
| telegram.utils.promise Module | ||
| ============================= | ||
|
|
||
| .. automodule:: telegram.utils.promise |
Member
There was a problem hiding this comment.
I think this should be autoclass
| telegram.utils.request Module | ||
| ============================= | ||
|
|
||
| .. automodule:: telegram.utils.request |
telegram/utils/promise.py
Outdated
| """A simple Promise implementation for use with the run_async decorator, DelayQueue etc. | ||
| Args: | ||
| pooled_function (callable): The callable that will be called concurrently. |
telegram/utils/promise.py
Outdated
| Args: | ||
| pooled_function (callable): The callable that will be called concurrently. | ||
| args (list|tuple): Positional arguments for ``pooled_function`` |
telegram/utils/promise.py
Outdated
| Args: | ||
| pooled_function (callable): The callable that will be called concurrently. | ||
| args (list|tuple): Positional arguments for ``pooled_function`` | ||
| kwargs (dict): Keyword arguments for ``pooled_function`` |
telegram/utils/promise.py
Outdated
| Attributes: | ||
| pooled_function (callable): The callable that will be called concurrently. | ||
| args (list|tuple): Positional arguments for ``pooled_function`` |
telegram/utils/promise.py
Outdated
| self._exception = None | ||
|
|
||
| def run(self): | ||
| """Calls the ``pooled_function`` callable.""" |
Member
There was a problem hiding this comment.
I think we can add : attr:`pooled_function` here
telegram/utils/promise.py
Outdated
| calculated. ``None`` means indefinite. Default is ``None``. | ||
| Returns: | ||
| Returns the return value of ``pooled_function`` or ``None`` if the ``timeout`` expires. |
telegram/utils/promise.py
Outdated
| Returns the return value of ``pooled_function`` or ``None`` if the ``timeout`` expires. | ||
| Raises: | ||
| Any exception raised by ``pooled_function``. |
telegram/utils/promise.py
Outdated
|
|
||
| @property | ||
| def exception(self): | ||
| """The exception raised by ``pooled_function`` or ``None`` if no exception has been raised |
[CI skip]
Eldinnie
approved these changes
Mar 5, 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.
Adds documentation files for
telegram.utils.promiseandtelegram.utils.requestand some new docstrings/improvements.