8000 Cleaning up docstrings · jwcunhagit/python-docs-samples@af16d6b · GitHub
[go: up one dir, main page]
Skip to content

Commit af16d6b

Browse files
author
Jon Wayne Parrott
committed
Cleaning up docstrings
1 parent 679698f commit af16d6b

File tree

18 files changed

+53
-18
lines changed

18 files changed

+53
-18
lines changed

‎appengine/app_identity/signing/main.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
"""
1616
Sample Google App Engine application that demonstrates usage of the app
1717
identity API.
18+
19+
For more information about App Engine, see README.md under /appengine.
1820
"""
1921

2022
# [START all]

‎appengine/bigquery/main.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@
1717
Sample App Engine application that demonstrates authentication to BigQuery
1818
using User OAuth2 as opposed to OAuth2 Service Accounts.
1919
20-
For more information about BigQuery, see README.md under /bigquery.
21-
For more information about App Engine, see README.md under /appengine.
20+
For more information, see README.md.
2221
"""
2322

2423
import json

‎appengine/blobstore/main.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""
16+
Sample application that demonstrates how to use the App Engine Blobstore API.
17+
18+
For more information, see README.md.
19+
"""
20+
1521
# [START all]
1622
from google.appengine.api import users
1723
from google.appengine.ext import blobstore

‎appengine/cloudsql/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
Sample App Engine application demonstrating how to connect to Google Cloud SQL
1717
using App Engine's native unix socket.
1818
19-
For more information about App Engine, see README.md under /appengine.
19+
For more information, see the README.md.
2020
"""
2121

2222
import os

‎appengine/i18n/main.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17-
"""A small example showing how to build an i18n app with App Engine."""
17+
"""Sample application that demonstrates how to internationalize and localize
18+
and App Engine application.
19+
20+
For more information, see README.md
21+
"""
1822

1923
from i18n_utils import BaseHandler
2024

‎appengine/images/main.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""
16+
Sample application that demonstrates how to use the App Engine Images API.
17+
18+
For more information, see README.md.
19+
"""
20+
1521
# [START all]
1622

1723
import cgi

‎appengine/mailgun/main.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,12 @@
1515
# limitations under the License.
1616

1717
"""
18-
Sample Google App Engine application that sends mail using Mailgun.
18+
Sample Google App Engine application that demonstrates how to send mail using
19+
Mailgun.
20+
21+
For more information, see README.md.
1922
"""
23+
2024
from urllib import urlencode
2125

2226
import httplib2

‎appengine/memcache/guestbook/main.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""
16+
Sample application that demonstrates how to use the App Engine Memcache API.
17+
18+
For more information, see README.md.
19+
"""
20+
1521
# [START all]
1622

1723
import cgi

‎appengine/multitenancy/datastore.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
Sample App Engine application demonstrating how to use the Namespace Manager
1717
API with Datastore.
1818
19-
For more information about App Engine, see README.md under /appengine.
19+
For more information, see README.md.
2020
"""
2121

2222
# [START all]

‎appengine/multitenancy/memcache.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
Sample App Engine application demonstrating how to use the Namespace Manager
1717
API with Memcache.
1818
19-
For more information about App Engine, see README.md under /appengine.
19+
For more information, see README.md.
2020
"""
2121

2222
# [START all]

‎appengine/multitenancy/taskqueue.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
Sample App Engine application demonstrating how to use the Namespace Manager
1717
API with Memcache.
1818
19-
For more information about App Engine, see README.md under /appengine.
19+
For more information, see README.md.
2020
"""
2121

2222
# [START all]

‎appengine/ndb/modeling/contact_with_group_models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
This module provides models which implement structured properties,
1818
strongly consistent querying, and one-to-many grouping.
1919
20-
Classes: Contact, Group, PhoneNumber
20+
For more information, see README.md.
2121
"""
2222

2323

‎appengine/ndb/modeling/keyproperty_models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
This module provides models with a relationship with ndb.KeyProperty to
1919
allow a single contact to have multiple phone numbers.
2020
21-
Classes: Contact, PhoneNumber
21+
For more information, see README.md.
2222
"""
2323

2424

‎appengine/ndb/modeling/naive_models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
"""A simple model for representing an address book contact.
1616
17-
This module provides a simple model, Contact.
17+
For more information, see README.md.
1818
"""
1919

2020
# This is the first naive model for starting the article. In the

‎appengine/ndb/modeling/parent_child_models.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414

1515
"""Models representing a contact with multiple phone numbers.
1616
17-
This module provides models with a relationship with parent-child
18-
relationship to allow strong consistent query.
17+
This module shows a parent-child relationship implemented via entity groups
18+
that allows strongly consistent querying.
1919
20-
Classes: Contact, PhoneNumber
20+
For more information, see README.md.
2121
"""
2222

2323

‎appengine/ndb/modeling/relation_model_models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
This module provides models with structured properties, strong
1818
consistent querying, one-to-many grouping, many-to-many relationships.
1919
20-
Classes: Company, ContactCompany, Contact, Group, PhoneNumber
20+
For more information, see README.md.
2121
"""
2222

2323

‎appengine/ndb/modeling/structured_property_models.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414

1515
"""Models for representing a contact with multiple phone numbers.
1616
17-
This module provides models with NDB's StructuredProperty to represent
18-
the one-to-many relationship.
17+
This module provides models that represent a one-to-many relationship by
18+
embedding a list of related entites using NDB's StructuredProperty.
1919
20-
Classes: Contact, PhoneNumber
20+
For more information, see README.md.
2121
"""
2222

2323

‎appengine/ndb/overview/main.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""Cloud Datastore NDB API guestbook sample.
16+
17+
This sample is used on this page:
18+
https://cloud.google.com/appengine/docs/python/ndb/
19+
20+
For more information, see README.md
21+
"""
22+
1523
# [START all]
1624
import cgi
1725
import urllib

0 commit comments

Comments
 (0)
0