From 277abb664b1e2da2194c0b1b41a1e63c6b9be490 Mon Sep 17 00:00:00 2001
From: Ross McFarland <rwmcfa1@gmail.com>
Date: Fri, 18 Oct 2024 16:57:44 -0700
Subject: [PATCH] Note about YamlProvider not preserving comments and
 formatting

---
 octodns/provider/yaml.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/octodns/provider/yaml.py b/octodns/provider/yaml.py
index b95eb00..1a2a512 100644
--- a/octodns/provider/yaml.py
+++ b/octodns/provider/yaml.py
@@ -73,6 +73,12 @@ class YamlProvider(BaseProvider):
         # (optional, default False)
         disable_zonefile: false
 
+    Note
+    ----
+
+    When using this provider as a target any existing comments or formatting
+    in the zone files will be lost when changes are applyed.
+
     Split Details
     -------------