documentation bug: returns & the number of zips in chicago
notuntoward opened this issue · 2 comments
notuntoward commented
The documentation says that this:
# Looking for Chicago and IL, but entered wrong spelling.
>>> res = search.by_city_and_state("cicago", "il")
>>> len(res) # 56 zipcodes in Chicago
56
will print 56
at the end.
However:
- It actually prints
5
because it's using the default value ofreturns=5
- If I supply
returns=5000
, so the number of zips isn't limited, the result is not56
but58
.
MacHu-GWU commented
Thank you I will look into it, you are right, I should have make it clear that returns is controls the limit
MacHu-GWU commented
@notuntoward actually it is mentioned at https://uszipcode.readthedocs.io/01-Tutorial/index.html#restrict-number-of-results-to-return