From a62139fafc4b1ac1e54eacfc4559700af8f0850c Mon Sep 17 00:00:00 2001
From: eternnoir <eternnoir@gmail.com>
Date: Sat, 27 Jun 2015 02:14:45 +0800
Subject: [PATCH] Add some comment

---
 telebot/__init__.py  | 42 ++++++++++++++++++++++++++++++++++++++++++
 telebot/apihelper.py | 16 ++++++++--------
 2 files changed, 50 insertions(+), 8 deletions(-)

diff --git a/telebot/__init__.py b/telebot/__init__.py
index 33f2f4a..8d06b8c 100644
--- a/telebot/__init__.py
+++ b/telebot/__init__.py
@@ -121,16 +121,58 @@ class TeleBot:
         return apihelper.forward_message(self.token, chat_id, from_chat_id, message_id)
 
     def send_photo(self, chat_id, photo, caption=None, reply_to_message_id=None, reply_markup=None):
+        """
+        Use this method to send photos.
+        :param chat_id:
+        :param photo:
+        :param caption:
+        :param reply_to_message_id:
+        :param reply_markup:
+        :return:
+        """
         return apihelper.send_photo(self.token, chat_id, photo, caption, reply_to_message_id, reply_markup)
 
     def send_audio(self, chat_id, data, reply_to_message_id=None, reply_markup=None):
+        """
+        Use this method to send audio files, if you want Telegram clients to display the file as a playable
+        voice message. For this to work, your audio must be in an .ogg file encoded with OPUS
+        :param chat_id:
+        :param data:
+        :param reply_to_message_id:
+        :param reply_markup:
+        :return:
+        """
         return apihelper.send_data(self.token, chat_id, data, 'audio', reply_to_message_id, reply_markup)
 
     def send_document(self, chat_id, data, reply_to_message_id=None, reply_markup=None):
+        """
+        Use this method to send general files.
+        :param chat_id:
+        :param data:
+        :param reply_to_message_id:
+        :param reply_markup:
+        :return:
+        """
         return apihelper.send_data(self.token, chat_id, data, 'document', reply_to_message_id, reply_markup)
 
     def send_sticker(self, chat_id, data, reply_to_message_id=None, reply_markup=None):
+        """
+        Use this method to send .webp stickers.
+        :param chat_id:
+        :param data:
+        :param reply_to_message_id:
+        :param reply_markup:
+        :return:
+        """
         return apihelper.send_data(self.token, chat_id, data, 'sticker', reply_to_message_id, reply_markup)
 
     def send_video(self, chat_id, data, reply_to_message_id=None, reply_markup=None):
+        """
+        Use this method to send video files, Telegram clients support mp4 videos.
+        :param chat_id:
+        :param data:
+        :param reply_to_message_id:
+        :param reply_markup:
+        :return:
+        """
         return apihelper.send_data(self.token, chat_id, data, 'video', reply_to_message_id, reply_markup)
diff --git a/telebot/apihelper.py b/telebot/apihelper.py
index 0ced9ac..65fa75e 100644
--- a/telebot/apihelper.py
+++ b/telebot/apihelper.py
@@ -69,12 +69,12 @@ def send_photo(token, chat_id, photo, caption=None, reply_to_message_id=None, re
     req = requests.post(request_url, params=payload, files=files)
     return req.json()
 
-def send_data(token, chat_id, data, type, reply_to_message_id=None, reply_markup=None):
+def send_data(token, chat_id, data, data_type, reply_to_message_id=None, reply_markup=None):
     api_url = telebot.API_URL
-    method_url = get_method_by_type(type)
+    method_url = get_method_by_type(data_type)
     request_url = api_url + 'bot' + token + '/' + method_url
     payload = {'chat_id': chat_id}
-    files = {type: data}
+    files = {data_type: data}
     if reply_to_message_id:
         payload['reply_to_message_id'] = reply_to_message_id
     if reply_markup:
@@ -82,12 +82,12 @@ def send_data(token, chat_id, data, type, reply_to_message_id=None, reply_markup
     req = requests.post(request_url, params=payload, files=files)
     return req.json()
 
-def get_method_by_type(type):
-    if type == 'audio':
+def get_method_by_type(data_type):
+    if data_type == 'audio':
         return 'sendAudio'
-    if type == 'document':
+    if data_type == 'document':
         return 'sendDocument'
-    if type == 'sticker':
+    if data_type == 'sticker':
         return 'sendSticker'
-    if type == 'video':
+    if data_type == 'video':
         return 'sendVideo'