Skip to content

Commit

Permalink
docs: document description field of Marker (#507)
Browse files Browse the repository at this point in the history
  • Loading branch information
antoni-szych-rtbhouse authored Feb 1, 2024
1 parent 503dd34 commit 28a799a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion voluptuous/schema_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 28a799a

Please sign in to comment.