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

BaseModel class attributes documented #5787

Merged
merged 1 commit into from
May 18, 2023
Merged

BaseModel class attributes documented #5787

merged 1 commit into from
May 18, 2023

Conversation

tpdorsey
Copy link
Contributor

@tpdorsey tpdorsey commented May 17, 2023

BaseModel attributes are documented in API documentation, and added a link from the Models documentation to full class details.

Closes #5079

Change Summary

Related issue number

Checklist

  • Unit tests for the changes exist
  • Tests pass on CI and coverage remains at 100%
  • Documentation reflects the changes where applicable
  • changes/<pull request or issue id>-<github username>.md file added describing change
    (see changes/README.md for details)
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer: @lig

@tpdorsey
Copy link
Contributor Author

please review

Copy link
Contributor

@lig lig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technical LGTM :)

@tpdorsey tpdorsey merged commit e0a9e6d into main May 18, 2023
43 checks passed
@tpdorsey tpdorsey deleted the docs-basemodel-5079 branch May 18, 2023 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document pydantic's private/protected names
2 participants