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

Description argument not documented #471

Closed
steverep opened this issue Oct 16, 2022 · 2 comments · Fixed by #507
Closed

Description argument not documented #471

steverep opened this issue Oct 16, 2022 · 2 comments · Fixed by #507

Comments

@steverep
Copy link

The description argument for the Marker class (or any subclass) is not documented anywhere, so it's unclear what's allowed and how it affects the schema.

@spacegaier
Copy link
Collaborator

You can see in the PR that added that option (#307) it is not really used inside the library itself, but allows having a description that can then be used by the schema creator if required, e.g. for some introspection, see this issue with the reasoning behind that feature: #305

There is nothing specifically allowed for description. You can pass anything in.

@steverep
Copy link
Author

Thanks for the explanation. Pasting something similar into the doc string would have saved me some confusion.

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 a pull request may close this issue.

2 participants