summaryrefslogtreecommitdiffstats
path: root/src/root.zig
diff options
context:
space:
mode:
Diffstat (limited to 'src/root.zig')
-rw-r--r--src/root.zig5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/root.zig b/src/root.zig
index 0a83c5c..d97c8ea 100644
--- a/src/root.zig
+++ b/src/root.zig
@@ -44,6 +44,10 @@
//! };
//! ```
//!
+//! After `error.NotFound`, `diag.faixa()` may name the municipality the CEP
+//! would have belonged to. It is context for the failure and never an address —
+//! see `Faixa`.
+//!
//! Note on field names: the API surface is English, but the **data fields keep
//! the API's own Portuguese names** (`logradouro`, `bairro`, `localidade`).
//! What you read in the JSON is what you access on the value.
@@ -77,6 +81,7 @@ pub const Diagnostics = errors.Diagnostics;
pub const isRetriable = errors.isRetriable;
pub const Address = model.Address;
+pub const Faixa = model.Faixa;
pub const Geo = model.Geo;
pub const Health = model.Health;