From ae0497bb5ad9778685ac1ecc27686cfe99d0e8b5 Mon Sep 17 00:00:00 2001
From: Samuel Parkinson <samuel.parkinson@ft.com>
Date: Thu, 16 Feb 2023 13:48:47 +0000
Subject: [PATCH] Add class comment

---
 octodns/processor/spf.py | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/octodns/processor/spf.py b/octodns/processor/spf.py
index 0f5b5d6..40ffa72 100644
--- a/octodns/processor/spf.py
+++ b/octodns/processor/spf.py
@@ -22,6 +22,35 @@ class SpfDnsLookupException(ProcessorException):
 
 
 class SpfDnsLookupProcessor(BaseProcessor):
+    '''
+    Validate that SPF values in TXT records are valid.
+
+    Example usage:
+
+    processors:
+      spf:
+        class: octodns.processor.spf.SpfDnsLookupProcessor
+
+    zones:
+      example.com.:
+        sources:
+          - config
+        processors:
+          - spf
+        targets:
+          - route53
+
+    The validation can be skipped for specific records by setting the lenient
+    flag, e.g.
+
+    _spf:
+      octodns:
+        lenient: true
+      ttl: 86400
+      type: TXT
+      value: v=spf1 ptr ~all
+    '''
+
     log = getLogger('SpfDnsLookupProcessor')
 
     def __init__(self, name):