Removed mention of embassies + other doc cleanup

Author: oschwald

geoip2/models.py

@@ -51,8 +51,7 @@ class Country(object):
 
       Object for the country represented by the users of the IP address
       when that country is different than the country in ``country``. For
-      instance, the country represented by an overseas military base or
-      embassy.
+      instance, the country represented by an overseas military base.
 
       :type: :py:class:`geoip2.records.RepresentedCountry`
 
@@ -134,8 +133,7 @@ class City(Country):
 
       Object for the country represented by the users of the IP address
       when that country is different than the country in ``country``. For
-      instance, the country represented by an overseas military base or
-      embassy.
+      instance, the country represented by an overseas military base.
 
       :type: :py:class:`geoip2.records.RepresentedCountry`
 
@@ -212,8 +210,7 @@ class Insights(City):
 
       Object for the country represented by the users of the IP address
       when that country is different than the country in ``country``. For
-      instance, the country represented by an overseas military base or
-      embassy.
+      instance, the country represented by an overseas military base.
 
       :type: :py:class:`geoip2.records.RepresentedCountry`
 

geoip2/records.py

@@ -50,7 +50,7 @@ class City(PlaceRecord):
 
     This class contains the city-level data associated with an IP address.
 
-    This record is returned by all the end points except the Country end point.
+    This record is returned by ``city`` and ``insights``.
 
     Attributes:
 
@@ -64,22 +64,21 @@ class City(PlaceRecord):
 
     .. attribute:: geoname_id
 
-      The GeoName ID for the city. This attribute is returned by all end
-      points.
+      The GeoName ID for the city.
 
       :type: int
 
     .. attribute:: name
 
       The name of the city based on the locales list passed to the
-      constructor. This attribute is returned by all end points.
+      constructor.
 
       :type: unicode
 
     .. attribute:: names
 
       A dictionary where the keys are locale codes
-      and the values are names. This attribute is returned by all end points.
+      and the values are names.
 
       :type: dict
 
@@ -94,36 +93,33 @@ class Continent(PlaceRecord):
     This class contains the continent-level data associated with an IP
     address.
 
-    This record is returned by all the end points.
-
     Attributes:
 
 
     .. attribute:: code
 
       A two character continent code like "NA" (North America)
-      or "OC" (Oceania). This attribute is returned by all end points.
+      or "OC" (Oceania).
 
       :type: unicode
 
     .. attribute:: geoname_id
 
-      The GeoName ID for the continent. This
-      attribute is returned by all end points.
+      The GeoName ID for the continent.
 
       :type: int
 
     .. attribute:: name
 
       Returns the name of the continent based on the locales list passed to
-      the constructor. This attribute is returned by all end points.
+      the constructor.
 
       :type: unicode
 
     .. attribute:: names
 
       A dictionary where the keys are locale codes
-      and the values are names. This attribute is returned by all end points.
+      and the values are names.
 
       :type: dict
 
@@ -137,8 +133,6 @@ class Country(PlaceRecord):
 
     This class contains the country-level data associated with an IP address.
 
-    This record is returned by all the end points.
-
     Attributes:
 
 
@@ -152,30 +146,29 @@ class Country(PlaceRecord):
 
     .. attribute:: geoname_id
 
-      The GeoName ID for the country. This attribute is
-      returned by all end points.
+      The GeoName ID for the country.
 
       :type: int
 
     .. attribute:: iso_code
 
       The two-character `ISO 3166-1
       <http://en.wikipedia.org/wiki/ISO_3166-1>`_ alpha code for the
-      country. This attribute is returned by all end points.
+      country.
 
       :type: unicode
 
     .. attribute:: name
 
       The name of the country based on the locales list passed to the
-      constructor. This attribute is returned by all end points.
+      constructor.
 
       :type: unicode
 
     .. attribute:: names
 
       A dictionary where the keys are locale codes and the values
-      are names. This attribute is returned by all end points.
+      are names.
 
       :type: dict
 
@@ -189,9 +182,7 @@ class RepresentedCountry(Country):
 
     This class contains the country-level data associated with an IP address
     for the IP's represented country. The represented country is the country
-    represented by something like a military base or embassy.
-
-    This record is returned by all the end points.
+    represented by something like a military base.
 
     Attributes:
 
@@ -206,30 +197,28 @@ class RepresentedCountry(Country):
 
     .. attribute:: geoname_id
 
-      The GeoName ID for the country. This attribute is
-      returned by all end points.
+      The GeoName ID for the country.
 
       :type: int
 
     .. attribute:: iso_code
 
       The two-character `ISO 3166-1
       <http://en.wikipedia.org/wiki/ISO_3166-1>`_ alpha code for the country.
-      This attribute is returned by all end points.
 
       :type: unicode
 
     .. attribute:: name
 
       The name of the country based on the locales list passed to the
-      constructor. This attribute is returned by all end points.
+      constructor.
 
       :type: unicode
 
     .. attribute:: names
 
       A dictionary where the keys are locale codes and the values
-      are names. This attribute is returned by all end points.
+      are names.
 
       :type: dict
 
@@ -238,8 +227,7 @@ class RepresentedCountry(Country):
 
       A string indicating the type of entity that is representing the
       country. Currently we only return ``military`` but this could expand to
-      include other types such as ``embassy`` in the future. Returned by all
-      endpoints.
+      include other types in the future.
 
       :type: unicode
 
@@ -254,7 +242,7 @@ class Location(Record):
 
     This class contains the location data associated with an IP address.
 
-    This record is returned by all the end points except the Country end point.
+    This record is returned by `city` and `insights`.
 
     Attributes:
 
@@ -268,18 +256,15 @@ class Location(Record):
 
     .. attribute:: latitude
 
-      The latitude of the location as a floating
-      point number. This attribute is returned by all end points except the
-      Country end point.
+      The latitude of the location as a floating point number.
 
       :type: float
 
 
     .. attribute:: longitude
 
       The longitude of the location as a
-      floating point number. This attribute is returned by all end points
-      except the Country end point.
+      floating point number.
 
       :type: float
 
@@ -289,17 +274,14 @@ class Location(Record):
       location is in the US. MaxMind returns the same metro codes as the
       `Google AdWords API
       <https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions>`_.
-      This attribute is returned by all end points except the Country end
-      point.
 
       :type: int
 
     .. attribute:: time_zone
 
       The time zone associated with location, as
       specified by the `IANA Time Zone Database
-      <http://www.iana.org/time-zones>`_, e.g., "America/New_York". This
-      attribute is returned by all end points except the Country end point.
+      <http://www.iana.org/time-zones>`_, e.g., "America/New_York".
 
       :type: unicode
 
@@ -313,8 +295,6 @@ class MaxMind(Record):
 
     """Contains data related to your MaxMind account
 
-    This record is returned by all the end points.
-
     Attributes:
 
     .. attribute:: queries_remaining
@@ -334,16 +314,15 @@ class Postal(Record):
 
     This class contains the postal data associated with an IP address.
 
-    This record is returned by all the end points except the Country end point.
+    This attribute is returned by ``city`` and ``insights``.
 
     Attributes:
 
     .. attribute:: code
 
       The postal code of the location. Postal
       codes are not available for all countries. In some countries, this will
-      only contain part of the postal code. This attribute is returned by all
-      end points except the Country end point.
+      only contain part of the postal code.
 
       :type: unicode
 
@@ -365,7 +344,7 @@ class Subdivision(PlaceRecord):
 
     This class contains the subdivision data associated with an IP address.
 
-    This record is returned by all the end points except the Country end point.
+    This attribute is returned by ``city`` and ``insights``.
 
     Attributes:
 
@@ -379,32 +358,29 @@ class Subdivision(PlaceRecord):
 
     .. attribute:: geoname_id
 
-      This is a GeoName ID for the subdivision. This
-      attribute is returned by all end points except Country.
+      This is a GeoName ID for the subdivision.
 
       :type: int
 
     .. attribute:: iso_code
 
       This is a string up to three characters long
       contain the subdivision portion of the `ISO 3166-2 code
-      <http://en.wikipedia.org/wiki/ISO_3166-2>`_. This attribute is
-      returned by all end points except Country.
+      <http://en.wikipedia.org/wiki/ISO_3166-2>`_.
 
       :type: unicode
 
     .. attribute:: name
 
       The name of the subdivision based on the locales list passed to the
-      constructor. This attribute is returned by all end points.
+      constructor.
 
       :type: unicode
 
     .. attribute:: names
 
       A dictionary where the keys are locale codes and the
-      values are names. This attribute is returned by all end points except
-      Country.
+      values are names
 
       :type: dict
 
@@ -422,9 +398,7 @@ class Subdivisions(tuple):
     For instance, the response for Oxford in the United Kingdom would have
     England as the first element and Oxfordshire as the second element.
 
-    This collection is returned by all the end points except the Country
-    end point.
-
+    This attribute is returned by ``city`` and ``insights``.
     """
     # pylint:disable=W0142
     def __new__(cls, locales, *subdivisions):
@@ -457,8 +431,6 @@ class Traits(Record):
 
     This class contains the traits data associated with an IP address.
 
-    This record is returned by all the end points.
-
     This class has the following attributes:
 
 
@@ -495,24 +467,22 @@ class Traits(Record):
       is for. If you performed a "me" lookup against the web service, this
       will be the externally routable IP address for the system the code is
       running on. If the system is behind a NAT, this may differ from the IP
-      address locally assigned to it. This attribute is returned by all end
-      points.
+      address locally assigned to it.
 
       :type: unicode
 
     .. attribute:: is_anonymous_proxy
 
       This is true if the IP is an anonymous
       proxy. See http://dev.maxmind.com/faq/geoip#anonproxy for further
-      details. This attribute is returned by all end points.
+      details.
 
       :type: bool
 
     .. attribute:: is_satellite_provider
 
       This is true if the IP address is from a satellite provider that
-      provides service to multiple countries. This attribute is returned
-      by all end points.
+      provides service to multiple countries.
 
       :type: bool