mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-08-28 21:07:59 +00:00
Code Issues Releases Wiki Activity

Update docstrings

Browse Source
This commit is contained in:
Dan 2018-02-15 21:12:42 +01:00
parent ad6cfcd165
commit a961eb88db
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pyrogram/client/client.py
View File

@ -706,7 +706,7 @@ class Client:
def resolve_peer(self, peer_id: int or str): def resolve_peer(self, peer_id: int or str):
"""Use this method to get the *InputPeer* of a known *peer_id*. """Use this method to get the *InputPeer* of a known *peer_id*.
It is intended to be used when working with Raw Functions (i.e: a Telegram API method you wish to use which is It is intended to be used when working with Raw Functions (i.e: a Telegram API method you wish to use which is
not available yet in the Client class as an easy-to-use method). not available yet in the Client class as an easy-to-use method).
Args: Args:

6
pyrogram/client/input_media.py
View File

@ -20,10 +20,11 @@
class InputMedia: class InputMedia:
class Photo: class Photo:
"""This object represents a photo to be sent inside an album. """This object represents a photo to be sent inside an album.
It is intended to be used with :obj:`pyrogram.Client.send_media_group`.
Args: Args:
media (:obj:`str`): media (:obj:`str`):
File to send. Photo file to send.
Pass a file path as string to send a photo that exists on your local machine. Pass a file path as string to send a photo that exists on your local machine.
caption (:obj:`str`): caption (:obj:`str`):
@ -45,10 +46,11 @@ class InputMedia:
class Video: class Video:
"""This object represents a video to be sent inside an album. """This object represents a video to be sent inside an album.
It is intended to be used with :obj:`pyrogram.Client.send_media_group`.
Args: Args:
media (:obj:`str`): media (:obj:`str`):
File to send. Video file to send.
Pass a file path as string to send a video that exists on your local machine. Pass a file path as string to send a video that exists on your local machine.
caption (:obj:`str`): caption (:obj:`str`):