Skip to content

Commit 17c2503

Browse files
committed
more doc strings
1 parent 4be0834 commit 17c2503

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
SPHINXPROJ = pizzapi
8-
SOURCEDIR = .
9-
BUILDDIR = _build
8+
SOURCEDIR = source
9+
BUILDDIR = build
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:

pizzapi/address.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,19 @@
33
from .urls import Urls, COUNTRY_USA
44

55
class Address(object):
6-
"""
7-
Create an address, for finding stores and placing orders.
6+
"""Create an address, for finding stores and placing orders.
87
98
The Address object describes a street address in North America (USA or
109
Canada, for now). Callers can use the Address object's methods to find
1110
the closest or nearby stores from the API.
11+
12+
Attributes:
13+
street (String): Street address
14+
city (String): North American city
15+
region (String): North American region (state, province, territory)
16+
zip (String): North American ZIP code
17+
urls (String): Country-specific URLs
18+
country (String): Country
1219
"""
1320

1421
def __init__(self, street, city, region='', zip='', country=COUNTRY_USA, *args):
@@ -33,8 +40,7 @@ def line2(self):
3340
return '{City}, {Region}, {PostalCode}'.format(**self.data)
3441

3542
def nearby_stores(self, service='Delivery'):
36-
"""
37-
Query the API to find nearby stores.
43+
"""Query the API to find nearby stores.
3844
3945
nearby_stores will filter the information we receive from the API
4046
to exclude stores that are not currently online (!['IsOnlineNow']),

0 commit comments

Comments
 (0)