Set explicit pattern for 'no-docstring-rgx'.

tseaver · tseaver · commit 17afa7180f9a · 2016-05-17T16:44:12.000-04:00
Leaving it unset disabled the 'missing-docstring' check. Add missing docstrings uncovered thereby. Closes googleapis#1800.
diff --git a/gcloud/bigquery/_helpers.py b/gcloud/bigquery/_helpers.py
@@ -18,31 +18,37 @@
 
 
 def _not_null(value, field):
+    """Check whether 'value' should be coerced to 'field' type."""
     return value is not None or field.mode != 'NULLABLE'
 
 
 def _int_from_json(value, field):
+    """Coerce 'value' to an int, if set or not nullable."""
     if _not_null(value, field):
         return int(value)
 
 
 def _float_from_json(value, field):
+    """Coerce 'value' to a float, if set or not nullable."""
     if _not_null(value, field):
         return float(value)
 
 
 def _bool_from_json(value, field):
+    """Coerce 'value' to a bool, if set or not nullable."""
     if _not_null(value, field):
         return value.lower() in ['t', 'true', '1']
 
 
 def _datetime_from_json(value, field):
+    """Coerce 'value' to a datetime, if set or not nullable."""
     if _not_null(value, field):
         # value will be a float in seconds, to microsecond precision, in UTC.
         return _datetime_from_microseconds(1e6 * float(value))
 
 
 def _record_from_json(value, field):
+    """Coerce 'value' to a mapping, if set or not nullable."""
     if _not_null(value, field):
         record = {}
         for subfield, cell in zip(field.fields, value['f']):
@@ -56,6 +62,7 @@ def _record_from_json(value, field):
 
 
 def _string_from_json(value, _):
+    """NOOP string -> string coercion"""
     return value
 
 
@@ -70,6 +77,7 @@ def _string_from_json(value, _):
 
 
 def _rows_from_json(rows, schema):
+    """Convert JSON row data to rows w/ appropriate types."""
     rows_data = []
     for row in rows:
         row_data = []
@@ -132,6 +140,10 @@ def __init__(self, name, property_type):
         self.property_type = property_type
 
     def _validate(self, value):
+        """Ensure that 'value' is of the appropriate type.
+
+        :raises: ValueError on a type mismatch.
+        """
         if not isinstance(value, self.property_type):
             raise ValueError('Required type: %s' % (self.property_type,))
 
diff --git a/gcloud/bigquery/job.py b/gcloud/bigquery/job.py
@@ -933,6 +933,11 @@ def __init__(self, name, query, client):
     """
 
     def _destination_table_resource(self):
+        """Create a JSON resource for the destination table.
+
+        Helper for :meth:`_populate_config_resource` and
+        :meth:`_scrub_local_properties`
+        """
         if self.destination is not None:
             return {
                 'projectId': self.destination.project,
diff --git a/gcloud/bigtable/cluster.py b/gcloud/bigtable/cluster.py
@@ -241,6 +241,10 @@ def table(self, table_id):
         return Table(table_id, self)
 
     def _update_from_pb(self, cluster_pb):
+        """Refresh self from the server-provided protobuf.
+
+        Helper for :meth:`from_pb` and :meth:`reload`.
+        """
         if not cluster_pb.display_name:  # Simple field (string)
             raise ValueError('Cluster protobuf does not contain display_name')
         if not cluster_pb.serve_nodes:  # Simple field (int32)
diff --git a/gcloud/client.py b/gcloud/client.py
@@ -150,6 +150,7 @@ def __init__(self, project=None):
 
     @staticmethod
     def _determine_default(project):
+        """Helper:  use default project detection."""
         return _determine_default_project(project)
 
 
diff --git a/gcloud/datastore/client.py b/gcloud/datastore/client.py
@@ -174,6 +174,7 @@ def __init__(self, project=None, namespace=None,
 
     @staticmethod
     def _determine_default(project):
+        """Helper:  override default project detection."""
         return _determine_default_project(project)
 
     def _push_batch(self, batch):
diff --git a/scripts/pylintrc_default b/scripts/pylintrc_default
@@ -299,7 +299,7 @@ method-rgx=[a-z_][a-z0-9_]{2,35}$
 
 # Regular expression which should only match function or class names that do
 # not require a docstring.
-# DEFAULT:  no-docstring-rgx=__.*__
+no-docstring-rgx=__.*__
 
 # Minimum line length for functions/classes that require docstrings, shorter
 # ones are exempt.
