summaryrefslogtreecommitdiffstats
path: root/include/cepis/cepis.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/cepis/cepis.hpp')
-rw-r--r--include/cepis/cepis.hpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/cepis/cepis.hpp b/include/cepis/cepis.hpp
index 4ac3f1f..1861d88 100644
--- a/include/cepis/cepis.hpp
+++ b/include/cepis/cepis.hpp
@@ -28,8 +28,10 @@
/// ```cpp
/// try {
/// const cepis::Address a = cepis::lookup(cep_from_form);
-/// } catch (const cepis::CepNotFound&) {
-/// // the CEP does not exist: ask the user for another
+/// } catch (const cepis::CepNotFound& error) {
+/// // the CEP does not exist: ask the user for another. `error.faixa()`
+/// // often names the municipality it would have belonged to — context for
+/// // the message, never an address.
/// } catch (const cepis::Error&) {
/// // network, server, rate limit: retry later
/// }