Merge pull request #142 from GoogleCloudPlatform/appengine-docstring-…

…cleanup Cleaning up docstrings
GoogleCloudPlatform · Nov 12, 2015 · 3e63a0b · 3e63a0b
2 parents 3a601e4 + af16d6b
commit 3e63a0b
Show file tree

Hide file tree

Showing 18 changed files with 53 additions and 18 deletions.
diff --git a/appengine/app_identity/signing/main.py b/appengine/app_identity/signing/main.py
@@ -15,6 +15,8 @@
 """
 Sample Google App Engine application that demonstrates usage of the app
 identity API.
+
+For more information about App Engine, see README.md under /appengine.
 """
 
 # [START all]

diff --git a/appengine/bigquery/main.py b/appengine/bigquery/main.py
@@ -17,8 +17,7 @@
 Sample App Engine application that demonstrates authentication to BigQuery
 using User OAuth2 as opposed to OAuth2 Service Accounts.
 
-For more information about BigQuery, see README.md under /bigquery.
-For more information about App Engine, see README.md under /appengine.
+For more information, see README.md.
 """
 
 import json

diff --git a/appengine/blobstore/main.py b/appengine/blobstore/main.py
@@ -12,6 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+Sample application that demonstrates how to use the App Engine Blobstore API.
+
+For more information, see README.md.
+"""
+
 # [START all]
 from google.appengine.api import users
 from google.appengine.ext import blobstore

diff --git a/appengine/cloudsql/main.py b/appengine/cloudsql/main.py
@@ -16,7 +16,7 @@
 Sample App Engine application demonstrating how to connect to Google Cloud SQL
 using App Engine's native unix socket.
 
-For more information about App Engine, see README.md under /appengine.
+For more information, see the README.md.
 """
 
 import os

diff --git a/appengine/i18n/main.py b/appengine/i18n/main.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""A small example showing how to build an i18n app with App Engine."""
+"""Sample application that demonstrates how to internationalize and localize
+and App Engine application.
+
+For more information, see README.md
+"""
 
 from i18n_utils import BaseHandler
 

diff --git a/appengine/images/main.py b/appengine/images/main.py
@@ -12,6 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+Sample application that demonstrates how to use the App Engine Images API.
+
+For more information, see README.md.
+"""
+
 # [START all]
 
 import cgi

diff --git a/appengine/mailgun/main.py b/appengine/mailgun/main.py
@@ -15,8 +15,12 @@
 # limitations under the License.
 
 """
-Sample Google App Engine application that sends mail using Mailgun.
+Sample Google App Engine application that demonstrates how to send mail using
+Mailgun.
+
+For more information, see README.md.
 """
+
 from urllib import urlencode
 
 import httplib2

diff --git a/appengine/memcache/guestbook/main.py b/appengine/memcache/guestbook/main.py
@@ -12,6 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""
+Sample application that demonstrates how to use the App Engine Memcache API.
+
+For more information, see README.md.
+"""
+
 # [START all]
 
 import cgi

diff --git a/appengine/multitenancy/datastore.py b/appengine/multitenancy/datastore.py
@@ -16,7 +16,7 @@
 Sample App Engine application demonstrating how to use the Namespace Manager
 API with Datastore.
 
-For more information about App Engine, see README.md under /appengine.
+For more information, see README.md.
 """
 
 # [START all]

diff --git a/appengine/multitenancy/memcache.py b/appengine/multitenancy/memcache.py
@@ -16,7 +16,7 @@
 Sample App Engine application demonstrating how to use the Namespace Manager
 API with Memcache.
 
-For more information about App Engine, see README.md under /appengine.
+For more information, see README.md.
 """
 
 # [START all]

diff --git a/appengine/multitenancy/taskqueue.py b/appengine/multitenancy/taskqueue.py
@@ -16,7 +16,7 @@
 Sample App Engine application demonstrating how to use the Namespace Manager
 API with Memcache.
 
-For more information about App Engine, see README.md under /appengine.
+For more information, see README.md.
 """
 
 # [START all]

diff --git a/appengine/ndb/modeling/contact_with_group_models.py b/appengine/ndb/modeling/contact_with_group_models.py
@@ -17,7 +17,7 @@
 This module provides models which implement structured properties,
 strongly consistent querying, and one-to-many grouping.
 
-Classes: Contact, Group, PhoneNumber
+For more information, see README.md.
 """
 
 

diff --git a/appengine/ndb/modeling/keyproperty_models.py b/appengine/ndb/modeling/keyproperty_models.py
@@ -18,7 +18,7 @@
 This module provides models with a relationship with ndb.KeyProperty to
 allow a single contact to have multiple phone numbers.
 
-Classes: Contact, PhoneNumber
+For more information, see README.md.
 """
 
 

diff --git a/appengine/ndb/modeling/naive_models.py b/appengine/ndb/modeling/naive_models.py
@@ -14,7 +14,7 @@
 
 """A simple model for representing an address book contact.
 
-This module provides a simple model, Contact.
+For more information, see README.md.
 """
 
 # This is the first naive model for starting the article.  In the

diff --git a/appengine/ndb/modeling/parent_child_models.py b/appengine/ndb/modeling/parent_child_models.py
@@ -14,10 +14,10 @@
 
 """Models representing a contact with multiple phone numbers.
 
-This module provides models with a relationship with parent-child
-relationship to allow strong consistent query.
+This module shows a parent-child relationship implemented via entity groups
+that allows strongly consistent querying.
 
-Classes: Contact, PhoneNumber
+For more information, see README.md.
 """
 
 

diff --git a/appengine/ndb/modeling/relation_model_models.py b/appengine/ndb/modeling/relation_model_models.py
@@ -17,7 +17,7 @@
 This module provides models with structured properties, strong
 consistent querying, one-to-many grouping, many-to-many relationships.
 
-Classes: Company, ContactCompany, Contact, Group, PhoneNumber
+For more information, see README.md.
 """
 
 

diff --git a/appengine/ndb/modeling/structured_property_models.py b/appengine/ndb/modeling/structured_property_models.py
@@ -14,10 +14,10 @@
 
 """Models for representing a contact with multiple phone numbers.
 
-This module provides models with NDB's StructuredProperty to represent
-the one-to-many relationship.
+This module provides models that represent a one-to-many relationship by
+embedding a list of related entites using NDB's StructuredProperty.
 
-Classes: Contact, PhoneNumber
+For more information, see README.md.
 """
 
 

diff --git a/appengine/ndb/overview/main.py b/appengine/ndb/overview/main.py
@@ -12,6 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+"""Cloud Datastore NDB API guestbook sample.
+
+This sample is used on this page:
+    https://cloud.google.com/appengine/docs/python/ndb/
+
+For more information, see README.md
+"""
+
 # [START all]
 import cgi
 import urllib