Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaning up docstrings #142

Merged
merged 1 commit into from
Nov 12, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions appengine/app_identity/signing/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
3 changes: 1 addition & 2 deletions appengine/bigquery/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions appengine/blobstore/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion appengine/cloudsql/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion appengine/i18n/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 6 additions & 0 deletions appengine/images/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion appengine/mailgun/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions appengine/memcache/guestbook/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion appengine/multitenancy/datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion appengine/multitenancy/memcache.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion appengine/multitenancy/taskqueue.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion appengine/ndb/modeling/contact_with_group_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""


Expand Down
2 changes: 1 addition & 1 deletion appengine/ndb/modeling/keyproperty_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""


Expand Down
2 changes: 1 addition & 1 deletion appengine/ndb/modeling/naive_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions appengine/ndb/modeling/parent_child_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""


Expand Down
2 changes: 1 addition & 1 deletion appengine/ndb/modeling/relation_model_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""


Expand Down
6 changes: 3 additions & 3 deletions appengine/ndb/modeling/structured_property_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""


Expand Down
8 changes: 8 additions & 0 deletions appengine/ndb/overview/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down