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

clean Model docstrings in JSON Schema #7210

Merged
merged 2 commits into from Aug 23, 2023
Merged

clean Model docstrings in JSON Schema #7210

merged 2 commits into from Aug 23, 2023

Conversation

samuelcolvin
Copy link
Member

@samuelcolvin samuelcolvin commented Aug 22, 2023

Change Summary

Fix description in JSON Schema when generated from a model docstring.

Related issue number

fix #7195

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: @dmontagu

@cloudflare-pages
Copy link

cloudflare-pages bot commented Aug 22, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0555abe
Status: ✅  Deploy successful!
Preview URL: https://3059dd7e.pydantic-docs2.pages.dev
Branch Preview URL: https://fix-model-docstrings.pydantic-docs2.pages.dev

View logs

@samuelcolvin
Copy link
Member Author

please review.

The original reporter as confirmed this fixes their use case - #7195 (comment).

@samuelcolvin samuelcolvin changed the title clean Model docstrings in JSON Schema, clean Model docstrings in JSON Schema Aug 23, 2023
@adriangb adriangb merged commit d110b47 into main Aug 23, 2023
50 checks passed
@adriangb adriangb deleted the fix-model-docstrings branch August 23, 2023 15:47
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.

Whitespace of docstrings is not correctly trimmed according to PEP-257
3 participants