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

Fix various minor issues in docstrings #8372

Merged
merged 3 commits into from
Dec 15, 2023
Merged

Conversation

dmontagu
Copy link
Contributor

No description provided.

Copy link

cloudflare-pages bot commented Dec 15, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: c5e4e86
Status: ✅  Deploy successful!
Preview URL: https://b4032533.pydantic-docs2.pages.dev
Branch Preview URL: https://dmontagu-minor-docs-fixes.pydantic-docs2.pages.dev

View logs

Copy link

codspeed-hq bot commented Dec 15, 2023

CodSpeed Performance Report

Merging #8372 will not alter performance

Comparing dmontagu/minor-docs-fixes (c5e4e86) with main (17faa91)

Summary

✅ 10 untouched benchmarks

@sydney-runkle sydney-runkle added the relnotes-ignore Omit this PR from the release notes. label Dec 15, 2023
Copy link
Member

@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.

LGTM overall, just a few questions and one or two suggestions 👍.

Thanks for doing this!

pydantic/fields.py Outdated Show resolved Hide resolved
pydantic/fields.py Show resolved Hide resolved
pydantic/fields.py Show resolved Hide resolved
@@ -679,20 +681,20 @@ def Field( # noqa: C901
multiple_of: Value must be a multiple of this. Only applicable to numbers.
min_length: Minimum length for strings.
max_length: Maximum length for strings.
pattern: Pattern for strings.
pattern: Pattern for strings (a regular expression).
Copy link
Member

Choose a reason for hiding this comment

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

Should we say anything here about configuring the regex_engine? Fine if not, bc I believe that's at the model_config level.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sounds good to me

pydantic/fields.py Show resolved Hide resolved
pydantic/json_schema.py Show resolved Hide resolved
pydantic/json_schema.py Show resolved Hide resolved
pydantic/type_adapter.py Show resolved Hide resolved
@sydney-runkle sydney-runkle added this to the Documentation Sprint milestone Dec 15, 2023
Co-authored-by: Sydney Runkle <54324534+sydney-runkle@users.noreply.github.com>
@sydney-runkle sydney-runkle merged commit a8f3f7a into main Dec 15, 2023
55 checks passed
@sydney-runkle sydney-runkle deleted the dmontagu/minor-docs-fixes branch December 15, 2023 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
relnotes-ignore Omit this PR from the release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants