From 81590885e2c209ffbe9d5b50a805c036c8ae2e0d Mon Sep 17 00:00:00 2001 From: Pradeep Tammali Date: Thu, 26 Feb 2026 22:13:20 +0100 Subject: [PATCH] fix: update public API docs as per SemVer --- CHANGELOG.md | 1 - README.md | 7 +++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cf81502..3c7f33c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,4 +14,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Domain checks: MX, SPF, DMARC, DKIM, SSL certificate. - CLI with `--timeout`, skip flags per check, and `--compact` JSON. - Library API: `validate_email_and_domain()`, `ValidationOptions`, `EmailDomainValidationResult`. -- Exceptions: `DomainPolicyError`. diff --git a/README.md b/README.md index 03428e4..2494dd8 100644 --- a/README.md +++ b/README.md @@ -118,8 +118,7 @@ higher level business logic for final trust decisions. ### DKIM Checks for DKIM records at `._domainkey.`. The validator -tries common selectors from [`DKIM_SELECTORS`](src/models.py#L79) and stops on -the first valid record found. +tries common DKIM selectors and stops on the first valid record found. In the worst case, this performs one DNS TXT lookup per selector candidate until a match is found (or candidates are exhausted). @@ -141,8 +140,8 @@ hostname/chain trust validation. ## Result models -Results are returned as dataclasses (for example: `EmailDomainValidationResult`, -`SPFVerificationReport`). See `src/models.py` for the full model list. +The library returns `EmailDomainValidationResult`; its attributes and nested +report types are defined in `src/models.py`. ## Further validation