Refactoring comments (#217)

* fix comments

* fix docstring describing module name

* modify name of bug_report issue template

* add rtype in docstring

* fix module name description in docstring

Author: okue

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,5 +1,5 @@
 ---
-name: Bug Report Template
+name: Bug Report
 about: Create a bug report
 labels: bug
 

linebot/api.py

@@ -215,6 +215,7 @@ def get_message_delivery_broadcast(self, date, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.MessageDeliveryBroadcastResponse`
         """
         response = self._get(
             '/v2/bot/message/delivery/broadcast?date={date}'.format(date=date),
@@ -236,6 +237,7 @@ def get_message_delivery_reply(self, date, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.MessageDeliveryReplyResponse`
         """
         response = self._get(
             '/v2/bot/message/delivery/reply?date={date}'.format(date=date),
@@ -257,6 +259,7 @@ def get_message_delivery_push(self, date, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.MessageDeliveryPushResponse`
         """
         response = self._get(
             '/v2/bot/message/delivery/push?date={date}'.format(date=date),
@@ -278,6 +281,7 @@ def get_message_delivery_multicast(self, date, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.MessageDeliveryMulticastResponse`
         """
         response = self._get(
             '/v2/bot/message/delivery/multicast?date={date}'.format(date=date),
@@ -888,6 +892,7 @@ def get_insight_message_delivery(self, date, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.InsightMessageDeliveryResponse`
         """
         response = self._get(
             '/v2/bot/insight/message/delivery?date={date}'.format(date=date),
@@ -907,6 +912,7 @@ def get_insight_followers(self, date, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.InsightFollowersResponse`
         """
         response = self._get(
             '/v2/bot/insight/followers?date={date}'.format(date=date),
@@ -926,6 +932,7 @@ def get_insight_demographic(self, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.InsightDemographicResponse`
         """
         response = self._get(
             '/v2/bot/insight/demographic',
@@ -945,6 +952,7 @@ def get_insight_message_event(self, request_id, timeout=None):
             or a (connect timeout, read timeout) float tuple.
             Default is self.http_client.timeout
         :type timeout: float | tuple(float, float)
+        :rtype: :py:class:`linebot.models.responses.InsightMessageEventResponse`
         """
         response = self._get(
             '/v2/bot/insight/message/event?requestId={request_id}'.format(request_id=request_id),

linebot/http_client.py

@@ -193,22 +193,22 @@ def headers(self):
 
     @abstractproperty
     def text(self):
-        """Get request body as text-decoded."""
+        """Get response body as text-decoded."""
         raise NotImplementedError
 
     @abstractproperty
     def content(self):
-        """Get request body as binary."""
+        """Get response body as binary."""
         raise NotImplementedError
 
     @abstractproperty
     def json(self):
-        """Get request body as json-decoded."""
+        """Get response body as json-decoded."""
         raise NotImplementedError
 
     @abstractmethod
     def iter_content(self, chunk_size=1024, decode_unicode=False):
-        """Get request body as iterator content (stream).
+        """Get response body as iterator content (stream).
 
         :param int chunk_size:
         :param bool decode_unicode:
@@ -238,21 +238,21 @@ def headers(self):
 
     @property
     def text(self):
-        """Get request body as text-decoded."""
+        """Get response body as text-decoded."""
         return self.response.text
 
     @property
     def content(self):
-        """Get request body as binary."""
+        """Get response body as binary."""
         return self.response.content
 
     @property
     def json(self):
-        """Get request body as json-decoded."""
+        """Get response body as json-decoded."""
         return self.response.json()
 
     def iter_content(self, chunk_size=1024, decode_unicode=False):
-        """Get request body as iterator content (stream).
+        """Get response body as iterator content (stream).
 
         :param int chunk_size:
         :param bool decode_unicode:

linebot/models/actions.py

@@ -12,7 +12,7 @@
 #  License for the specific language governing permissions and limitations
 #  under the License.
 
-"""linebot.models.template module."""
+"""linebot.models.actions module."""
 
 from __future__ import unicode_literals
 

linebot/webhook.py

@@ -12,7 +12,7 @@
 #  License for the specific language governing permissions and limitations
 #  under the License.
 
-"""linebot.http_client webhook."""
+"""linebot.webhook module."""
 
 from __future__ import unicode_literals