Skip to content

441 update pydantic section of docs#442

Merged
tomschr merged 4 commits intopython-semver:masterfrom
jbkroner:441-update-docs
Jul 4, 2025
Merged

441 update pydantic section of docs#442
tomschr merged 4 commits intopython-semver:masterfrom
jbkroner:441-update-docs

Conversation

@jbkroner
Copy link
Contributor

@jbkroner jbkroner commented Jul 26, 2024 •
edited
Loading

Closes #441

Small docs update, includes updated guidance on using Pydantic with python-semver.

Holding this in a draft state until the _VersionPydanticAnnotation is included in the next pydantic-extra-types release, probably version 2.10.0.

Any and all feedback appreciated, cheers.

@jbkroner jbkroner changed the title 441 update docs 441 update pydantic section of docs Jul 26, 2024
@jbkroner jbkroner mentioned this pull request Jul 26, 2024
Closed
@tomschr
Copy link
Member

tomschr commented Jul 28, 2024

Hi @jbkroner, are you ready with the PR or do you want to amend it? Just asking as the "Draft" label here is still in place and I didn't want to merge something unfinished. 😉

Thanks, looks good!

tomschr
tomschr reviewed Jul 28, 2024
View reviewed changes
Copy link
Member

@tomschr tomschr left a comment

Choose a reason for hiding this comment

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

@jbkroner Just a small, minor suggestion. Apart from that, it looks good! 👍

@jbkroner
Copy link
Contributor Author

jbkroner commented Aug 1, 2024 •
edited
Loading

Hi @jbkroner, are you ready with the PR or do you want to amend it? Just asking as the "Draft" label here is still in place and I didn't want to merge something unfinished. 😉

Thanks, looks good!

@tomschr I applied your feedback - keeping this in a draft state until the changes referenced in this update are included in an official pydantic-extra-types release. Looks like they typically release every month or so.

@oren0e
Copy link

oren0e commented Jun 28, 2025

@jbkroner - pydantic-extra-types did publish your addition right? So why this is still not merged as well?
Another question - will you added type work with pydantic versions 1.x?

@tomschr
Copy link
Member

tomschr commented Jun 30, 2025

@oren0e / @jbkroner I can merge it of course, just waiting for your final confirmation. Just let me know if it is ready. 🙂

jbkroner and others added 3 commits June 30, 2025 08:58
@jbkroner @tomschr
update docs
861b7ea
@jbkroner @tomschr
Update docs/advanced/combine-pydantic-and-semver.rst
cb68472 
Co-authored-by: Tom Schraitle <tomschr@users.noreply.github.com>
@jbkroner @tomschr
Update docs/advanced/combine-pydantic-and-semver.rst
802c070 
Co-authored-by: Tom Schraitle <tomschr@users.noreply.github.com>
@tomschr tomschr marked this pull request as ready for review June 30, 2025 07:00
@jbkroner
Copy link
Contributor Author

jbkroner commented Jul 4, 2025 •
edited
Loading

@jbkroner - pydantic-extra-types did publish your addition right? So why this is still not merged as well? Another question - will you added type work with pydantic versions 1.x?

This type was included in pydantic-extra-types 2.10 . There may have been some updates since it was included that may have slightly changed behavior, I'm checking that now.

@jbkroner
Copy link
Contributor Author

jbkroner commented Jul 4, 2025

@oren0e @tomschr tested with latest pydantic-extra-types release, made some tweaks but otherwise ready to merge!

@tomschr tomschr merged commit cc5b1d3 into python-semver:master Jul 4, 2025
2 checks passed
@tomschr
Copy link
Member

tomschr commented Jul 4, 2025

Great, thanks @jbkroner! Merged it. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tomschr tomschr tomschr left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update Pydantic + semver documentation

3 participants

@jbkroner @tomschr @oren0e