Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document description field of Marker #507

Merged
merged 1 commit into from
Feb 1, 2024
Merged

docs: document description field of Marker #507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion voluptuous/schema_builder.py
View file
Open in desktop
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
Loading