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

Overhaul Pydantic docs #79

Closed
dantownsend opened this issue Sep 1, 2021 · 5 comments
Closed

Overhaul Pydantic docs #79

dantownsend opened this issue Sep 1, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@dantownsend
Copy link
Member

Piccolo API has great Pydantic support, but the docs are a bit hidden away under the 'CRUD' section.

It would be good to move them, so 'Serialisation' is a top level topic in the docs, and contains much more examples about how to use create_pydantic_model.

@dantownsend dantownsend added the enhancement New feature or request label Sep 1, 2021
@dantownsend dantownsend added this to To do in Enhancements via automation Sep 1, 2021
@sinisaos
Copy link
Member

@dantownsend Since Pydantic serialization is now in the main Piccolo ORM repo. I can move 'Serialisation' docs (and add examples) from Piccolo API to Piccolo ORM and make a link to those docs in the Piccolo API serializers. What do you think?

@dantownsend
Copy link
Member Author

@sinisaos Yes, I totally agree.

@sinisaos
Copy link
Member

@dantownsend I'll make PR for Piccolo and Piccolo API to change docs.

@sinisaos
Copy link
Member

@dantownsend Can you please close this issue because it is done in main Piccolo ORM repo.

@dantownsend
Copy link
Member Author

@sinisaos Yep - good point

Enhancements automation moved this from To do to Done Nov 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

No branches or pull requests

2 participants