From e30634829b85aec6ecb671d87faa47361c2155db Mon Sep 17 00:00:00 2001 From: chris48s <chris.shaw480@gmail.com> Date: Sun, 25 Mar 2018 19:07:15 +0100 Subject: [PATCH] add exceptions to docs --- docs/docs/geocoders.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/docs/geocoders.md b/docs/docs/geocoders.md index 30f6402..9ed3729 100644 --- a/docs/docs/geocoders.md +++ b/docs/docs/geocoders.md @@ -89,3 +89,21 @@ addressbase.models.DoesNotExist >>> g.get_code('lad') 'W06000012' ``` + +## Exceptions + +### CodesNotFoundException + +Raised by `AddressBaseGeocoder.get_code()` if no records in the ONSUD are found correspoding to a record in AddressBase. Extends `uk_geo_utils.geocoders.AddressBaseException`. + +### MultipleCodesException + +Raised by `AddressBaseGeocoder.get_code()` if a single code of the given type can not be assigned to all of the UPRNs described by a postcode. Extends `uk_geo_utils.geocoders.AddressBaseException`. + +### NorthernIrelandException + +Raised by `AddressBaseGeocoder.__init__()` when attempting to construct an `AddressBaseGeocoder` object with a postcode starting 'BT'. AddressBase does not cover Northern Ireland. Extends `django.core.exceptions.ObjectDoesNotExist` + +### AddressBaseNotImportedException + +Raised by `AddressBaseGeocoder.__init__()` when attempting to construct an `AddressBaseGeocoder` object if there are no records in the AddressBase table. Extends `django.core.exceptions.ObjectDoesNotExist`