Bulk reformat docstrings (#732)

Cleaned up using `docformatter`. Probably a one-time thing.

Author: stevemessick

kaggle/api/kaggle_api.py

@@ -26,7 +26,7 @@
 class Configuration:
 
   def __init__(self):
-    """Constructor"""
+    """Constructor."""
     # Default Base url
     self.host = _get_endpoint_from_env() or "https://www.kaggle.com/api/v1"
 
@@ -100,7 +100,7 @@ def logger_file(self, value):
 
   @property
   def debug(self):
-    """Debug status
+    """Debug status.
 
     :param value: The debug status, True or False.
     :type: bool
@@ -109,7 +109,7 @@ def debug(self):
 
   @debug.setter
   def debug(self, value):
-    """Debug status
+    """Debug status.
 
     :param value: The debug status, True or False.
     :type: bool

kaggle/api/kaggle_api_extended.py

@@ -74,121 +74,130 @@ def __init__(self,
 
   @property
   def order(self):
-    """Gets the order of this DatasetColumn.  # noqa: E501
+    """Gets the order of this DatasetColumn.  # noqa: E501.
 
-        The order that the column comes in, 0-based. (The first column is 0, second is 1, etc.)  # noqa: E501
+    The order that the column comes in, 0-based. (The first column is 0,
+    second is 1, etc.)  # noqa: E501
 
-        :return: The order of this DatasetColumn.  # noqa: E501
-        :rtype: float
-        """
+    :return: The order of this DatasetColumn.  # noqa: E501
+    :rtype: float
+    """
     return self._order
 
   @order.setter
   def order(self, order):
     """Sets the order of this DatasetColumn.
 
-        The order that the column comes in, 0-based. (The first column is 0, second is 1, etc.)  # noqa: E501
+    The order that the column comes in, 0-based. (The first column is 0,
+    second is 1, etc.)  # noqa: E501
 
-        :param order: The order of this DatasetColumn.  # noqa: E501
-        :type: float
-        """
+    :param order: The order of this DatasetColumn.  # noqa: E501
+    :type: float
+    """
 
     self._order = order
 
   @property
   def name(self):
-    """Gets the name of this DatasetColumn.  # noqa: E501
+    """Gets the name of this DatasetColumn.  # noqa: E501.
 
-        The column name  # noqa: E501
+    The column name  # noqa: E501
 
-        :return: The name of this DatasetColumn.  # noqa: E501
-        :rtype: str
-        """
+    :return: The name of this DatasetColumn.  # noqa: E501
+    :rtype: str
+    """
     return self._name
 
   @name.setter
   def name(self, name):
     """Sets the name of this DatasetColumn.
 
-        The column name  # noqa: E501
+    The column name  # noqa: E501
 
-        :param name: The name of this DatasetColumn.  # noqa: E501
-        :type: str
-        """
+    :param name: The name of this DatasetColumn.  # noqa: E501
+    :type: str
+    """
 
     self._name = name
 
   @property
   def type(self):
-    """Gets the type of this DatasetColumn.  # noqa: E501
+    """Gets the type of this DatasetColumn.  # noqa: E501.
 
-        The type of all of the fields in the column. Please see the data types on https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata  # noqa: E501
+    The type of all of the fields in the column. Please see the data
+    types on
+    https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata
+     # noqa: E501
 
-        :return: The type of this DatasetColumn.  # noqa: E501
-        :rtype: str
-        """
+    :return: The type of this DatasetColumn.  # noqa: E501
+    :rtype: str
+    """
     return self._type
 
   @type.setter
   def type(self, type):
     """Sets the type of this DatasetColumn.
 
-        The type of all of the fields in the column. Please see the data types on https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata  # noqa: E501
+    The type of all of the fields in the column. Please see the data
+    types on
+    https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata
+     # noqa: E501
 
-        :param type: The type of this DatasetColumn.  # noqa: E501
-        :type: str
-        """
+    :param type: The type of this DatasetColumn.  # noqa: E501
+    :type: str
+    """
 
     self._type = type
 
   @property
   def original_type(self):
-    """Gets the original_type of this DatasetColumn.  # noqa: E501
+    """Gets the original_type of this DatasetColumn.  # noqa: E501.
 
-        Used to store the original type of the column, which will be converted to Kaggle's types. For example, an `originalType` of `\"integer\"` would convert to a `type` of `\"numeric\"`  # noqa: E501
+    Used to store the original type of the column, which will be converted to Kaggle's types. For example, an `originalType` of `\"integer\"` would convert to a `type` of `\"numeric\"`  # noqa: E501
 
-        :return: The original_type of this DatasetColumn.  # noqa: E501
-        :rtype: str
-        """
+    :return: The original_type of this DatasetColumn.  # noqa: E501
+    :rtype: str
+    """
     return self._original_type
 
   @original_type.setter
   def original_type(self, original_type):
     """Sets the original_type of this DatasetColumn.
 
-        Used to store the original type of the column, which will be converted to Kaggle's types. For example, an `originalType` of `\"integer\"` would convert to a `type` of `\"numeric\"`  # noqa: E501
+    Used to store the original type of the column, which will be converted to Kaggle's types. For example, an `originalType` of `\"integer\"` would convert to a `type` of `\"numeric\"`  # noqa: E501
 
-        :param original_type: The original_type of this DatasetColumn.  # noqa: E501
-        :type: str
-        """
+    :param original_type: The original_type of this DatasetColumn.  # noqa: E501
+    :type: str
+    """
 
     self._original_type = original_type
 
   @property
   def description(self):
-    """Gets the description of this DatasetColumn.  # noqa: E501
+    """Gets the description of this DatasetColumn.  # noqa: E501.
 
-        The description of the column  # noqa: E501
+    The description of the column  # noqa: E501
 
-        :return: The description of this DatasetColumn.  # noqa: E501
-        :rtype: str
-        """
+    :return: The description of this DatasetColumn.  # noqa: E501
+    :rtype: str
+    """
     return self._description
 
   @description.setter
   def description(self, description):
     """Sets the description of this DatasetColumn.
 
-        The description of the column  # noqa: E501
+    The description of the column  # noqa: E501
 
-        :param description: The description of this DatasetColumn.  # noqa: E501
-        :type: str
-        """
+    :param description: The description of this DatasetColumn. # noqa:
+        E501
+    :type: str
+    """
 
     self._description = description
 
   def to_dict(self):
-    """Returns the model properties as a dict"""
+    """Returns the model properties as a dict."""
     result = {}
 
     for attr, _ in six.iteritems(self.column_types):
@@ -209,20 +218,20 @@ def to_dict(self):
     return result
 
   def to_str(self):
-    """Returns the string representation of the model"""
+    """Returns the string representation of the model."""
     return pprint.pformat(self.to_dict())
 
   def __repr__(self):
     """For `print` and `pprint`"""
     return self.to_str()
 
   def __eq__(self, other):
-    """Returns true if both objects are equal"""
+    """Returns true if both objects are equal."""
     if not isinstance(other, DatasetColumn):
       return False
 
     return self.__dict__ == other.__dict__
 
   def __ne__(self, other):
-    """Returns true if both objects are not equal"""
+    """Returns true if both objects are not equal."""
     return not self == other