From 1e0b99bc0f92778a489310fcea7ad30570014afc Mon Sep 17 00:00:00 2001
From: Pim van Pelt <pim@ipng.nl>
Date: Sat, 9 Apr 2022 20:35:58 +0000
Subject: [PATCH] Clarify that custom validators only get called iff yamale
 passes

---
 config/__init__.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/config/__init__.py b/config/__init__.py
index 65808d6..e9687d4 100644
--- a/config/__init__.py
+++ b/config/__init__.py
@@ -146,5 +146,9 @@ class Validator(object):
                rv, msgs = func(yaml)
             returning a Boolean success value in rv and a List of strings
             in msgs. The function will be passed the configuration YAML and
-            gets to opine if it's valid or not. """
+            gets to opine if it's valid or not.
+
+            Note: will only be called iff Yamale syntax-check succeeded,
+                  and it will be called after all built-in validators.
+            """
         self.validators.append(func)