8000 Use field description for RootModel schema description when there is … by LouisGobert · Pull Request #9214 · pydantic/pydantic · GitHub
[go: up one dir, main page]
Skip to content

Use field description for RootModel schema description when there is … #9214

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
Merged
sydney-runkle merged 1 commit into from
Apr 14, 2024
Merged

Use field description for RootModel schema description when there is … #9214

sydney-runkle merged 1 commit into from
Apr 14, 2024

Conversation

@LouisGobert
Copy link
Contributor
@LouisGobert LouisGobert commented Apr 11, 2024 •
edited by pydantic-hooky bot
Loading

Use field description or root for RootModel schema description when there is no docstring

Related issue number

fix #9160

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer: @samuelcolvin

@LouisGobert
Copy link
Contributor Author
LouisGobert commented Apr 11, 2024

please review

@codspeed-hq
Copy link
codspeed-hq bot commented Apr 11, 2024

CodSpeed Performance Report

Merging #9214 will not alter performance

Comparing LouisGobert:use-field-description-for-root-model (aeed6af) with main (7af856a)

Summary

✅ 13 untouched benchmarks

@sydney-runkle sydney-runkle added relnotes-feature relnotes-change Used for changes to existing functionality which don't have a better categorization. and removed relnotes-feature labels Apr 14, 2024
sydney-runkle
sydney-runkle approved these changes Apr 14, 2024
View reviewed changes
Copy link
Contributor
@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

Nice work!

@sydney-runkle sydney-runkle merged commit 2241983 into pydantic:main Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@sydney-runkle sydney-runkle sydney-runkle approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@samuelcolvin samuelcolvin

Labels

ready for review relnotes-change Used for changes to existing functionality which don't have a better categorization.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

RootModel.model_json_schema() ignores Field description

3 participants

@LouisGobert @sydney-runkle @samuelcolvin
0