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

Jump to bottom

Add examples for custom serializers in API docs #8234

Closed
sydney-runkle opened this issue Nov 27, 2023 · 5 comments
Closed

Add examples for custom serializers in API docs #8234

sydney-runkle opened this issue Nov 27, 2023 · 5 comments
Assignees
@sydney-runkle
Labels
documentation good first issue help wanted Pull Request welcome
Milestone
Documentation Sprint

Comments

@sydney-runkle
Copy link
Member

For PlainSerializer, model_serializer, and field_serializer.
@sydney-runkle sydney-runkle self-assigned this Nov 27, 2023
@sydney-runkle sydney-runkle added this to the v2.6.0 milestone Nov 27, 2023
@debakarr
Copy link

What about the documentation here: https://docs.pydantic.dev/latest/concepts/serialization/#custom-serializers

@sydney-runkle
Copy link
Member Author

@debakarr,

Right, but we want to have examples in the API docs as well

@hungtsetse hungtsetse mentioned this issue Jan 14, 2024
Merged
5 tasks
@hungtsetse
Copy link
Contributor

@sydney-runkle,

I've opened a PR and I managed to document examples consistently for 3 of them.
Hope it make sense.

@sydney-runkle
Copy link
Member Author

Also, let's add an example for WrapSerializer to round out the additions to functional_serializers.py.

@sydney-runkle
Copy link
Member Author

Closed by #8546

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sydney-runkle sydney-runkle

Labels
documentation good first issue help wanted Pull Request welcome
Projects
None yet
Milestone
Documentation Sprint
Development

No branches or pull requests
3 participants
@debakarr @hungtsetse @sydney-runkle