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

[docs] Add docstrings to Pydantic Models #7

Open
cricksmaidiene opened this issue May 7, 2023 · 0 comments
Open

[docs] Add docstrings to Pydantic Models #7

cricksmaidiene opened this issue May 7, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@cricksmaidiene
Copy link
Member

The pydantic models specified in dotlas.schemas requires function docstrings on what each model is used for, and whether or not it is inherited from, or inherited by other models. This will help developers understand the serialized API responses they receive a lot better.
@cricksmaidiene cricksmaidiene added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels May 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@cricksmaidiene