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.

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

Don't enforce type for unused description attribute #519

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

cdce8p
Copy link
Contributor

@cdce8p cdce8p commented Jun 25, 2024

description is an optional field, unused by Voluptuous itself, but can be
introspected by any external tool, for example to generate schema documentation.

As per the docstring, the description attribute is unused by voluptuous itself but can be used by external tools. It therefore shouldn't force the type to be str | None. If the tool prefers dict, that should be valid as well.

Refs home-assistant/core#120268

@cdce8p
Copy link
Contributor Author

cdce8p commented Jun 26, 2024

@alecthomas If you have some time, it would be great if you could take a look at this one and #521. These two are the last remaining changes needed for Home Assistant.

After they are merged, a new release (0.15.1) would be greatly appreciated.

@alecthomas alecthomas merged commit 4cde166 into alecthomas:master Jun 26, 2024
8 checks passed
@cdce8p cdce8p deleted the description-type branch June 26, 2024 22:09
@bdraco
Copy link
Contributor

bdraco commented Jun 27, 2024

Thank you !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants