From 28a799a6f7744367599078ef19b571d6758cf271 Mon Sep 17 00:00:00 2001 From: Antoni Szych Date: Thu, 1 Feb 2024 21:18:30 +0100 Subject: [PATCH] docs: document description field of Marker (#507) --- voluptuous/schema_builder.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/voluptuous/schema_builder.py b/voluptuous/schema_builder.py index 6ad8758..f7427f8 100644 --- a/voluptuous/schema_builder.py +++ b/voluptuous/schema_builder.py @@ -1020,7 +1020,11 @@ def __repr__(self): class Marker(object): - """Mark nodes for special treatment.""" + """Mark nodes for special treatment. + + `description` is an optional field, unused by Voluptuous itself, but can be used + introspected by any external tool, for example to generate schema documentation. + """ def __init__( self,