mirror of
https://github.com/pyrogram/pyrogram
synced 2025-08-28 12:57:52 +00:00
Add docstrings
This commit is contained in:
parent
eb36a8f261
commit
995167c534
@ -1,5 +1,21 @@
|
|||||||
class InputMedia:
|
class InputMedia:
|
||||||
class Photo:
|
class Photo:
|
||||||
|
"""This object represents a photo to be sent inside an album.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
media (:obj:`str`):
|
||||||
|
File to send.
|
||||||
|
Pass a file path as string to send a photo that exists on your local machine.
|
||||||
|
|
||||||
|
caption (:obj:`str`):
|
||||||
|
Caption of the photo to be sent, 0-200 characters
|
||||||
|
|
||||||
|
parse_mode (:obj:`str`):
|
||||||
|
Use :obj:`pyrogram.ParseMode.MARKDOWN` or :obj:`pyrogram.ParseMode.HTML` if you want Telegram apps
|
||||||
|
to show bold, italic, fixed-width text or inline URLs in your caption.
|
||||||
|
Defaults to Markdown.
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self,
|
def __init__(self,
|
||||||
media: str,
|
media: str,
|
||||||
caption: str = "",
|
caption: str = "",
|
||||||
@ -9,6 +25,22 @@ class InputMedia:
|
|||||||
self.parse_mode = parse_mode
|
self.parse_mode = parse_mode
|
||||||
|
|
||||||
class Video:
|
class Video:
|
||||||
|
"""This object represents a video to be sent inside an album.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
media (:obj:`str`):
|
||||||
|
File to send.
|
||||||
|
Pass a file path as string to send a video that exists on your local machine.
|
||||||
|
|
||||||
|
caption (:obj:`str`):
|
||||||
|
Caption of the video to be sent, 0-200 characters
|
||||||
|
|
||||||
|
parse_mode (:obj:`str`):
|
||||||
|
Use :obj:`pyrogram.ParseMode.MARKDOWN` or :obj:`pyrogram.ParseMode.HTML` if you want Telegram apps
|
||||||
|
to show bold, italic, fixed-width text or inline URLs in your caption.
|
||||||
|
Defaults to Markdown.
|
||||||
|
"""
|
||||||
|
|
||||||
def __init__(self,
|
def __init__(self,
|
||||||
media: str,
|
media: str,
|
||||||
caption: str = "",
|
caption: str = "",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user