Skip to content

Don't enforce type for unused description attribute#519

Merged
alecthomas merged 1 commit intoalecthomas:masterfrom
cdce8p:description-type
Jun 26, 2024
Merged

Don't enforce type for unused description attribute#519
alecthomas merged 1 commit intoalecthomas:masterfrom
cdce8p:description-type

Conversation

@cdce8p
Copy link
Copy Markdown
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
Copy Markdown
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
@cdce8p cdce8p deleted the description-type branch June 26, 2024 22:09
@bdraco
Copy link
Copy Markdown
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