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

chore: clarify frozen vs allow_mutation in docstring #8495

Conversation

themattmorris
Copy link
Contributor

Change Summary

Clarifies that frozen is the inverse of v1.allow_mutation in config docs.

Related issue number

fix #8488

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 - NA
  • 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

please review

Copy link

codspeed-hq bot commented Jan 5, 2024

CodSpeed Performance Report

Merging #8495 will not alter performance

Comparing themattmorris:frozen-vs-allow-mutation-docstring (90c8f85) with main (53bb2a8)

Summary

✅ 10 untouched benchmarks

@sydney-runkle sydney-runkle added the relnotes-ignore Omit this PR from the release notes. label Jan 5, 2024
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.

Looks great, thanks!

@sydney-runkle sydney-runkle merged commit 7eb7d84 into pydantic:main Jan 5, 2024
54 of 55 checks passed
@themattmorris themattmorris deleted the frozen-vs-allow-mutation-docstring branch January 5, 2024 22:27
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.

frozen description equates it to allow_mutation, but it is the inverse
2 participants