Skip to content

Fix example in populate_by_name documentation #11766

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
merged 1 commit into from
Apr 17, 2025
Merged

Fix example in populate_by_name documentation #11766

merged 1 commit into from
Apr 17, 2025

Conversation

gbaian10
Copy link
Contributor

@gbaian10 gbaian10 commented Apr 17, 2025 •
edited
Loading

Change Summary

fix the docstring of ConfigDict's populate_by_name.

Related issue number

fix #11765

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

@github-actions github-actions bot added the relnotes-fix Used for bugfixes. label Apr 17, 2025
@gbaian10 gbaian10 changed the title fix populate_by_name docstring error fix the docstring of ConfigDict's populate_by_name. Apr 17, 2025
@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Apr 17, 2025

CodSpeed Performance Report

Merging #11766 will not alter performance

Comparing gbaian10:fix/#11765 (3424448) with main (625dd42)

Summary

✅ 46 untouched benchmarks

@github-actions GitHub Actions
Copy link
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@Viicos Viicos changed the title fix the docstring of ConfigDict's populate_by_name. Fix example in populate_by_name documentation Apr 17, 2025
Viicos
Viicos approved these changes Apr 17, 2025
View reviewed changes
Copy link
Member

@Viicos Viicos left a comment

Choose a reason for hiding this comment

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

Thanks for the fix

@Viicos Viicos merged commit a3f42a4 into pydantic:main Apr 17, 2025
61 checks passed
@gbaian10 gbaian10 deleted the fix/#11765 branch April 17, 2025 08:19
@Viicos Viicos added relnotes-ignore Omit this PR from the release notes. and removed relnotes-fix Used for bugfixes. labels Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Viicos Viicos Viicos approved these changes

Assignees
No one assigned
Labels
relnotes-ignore Omit this PR from the release notes.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation error: Incorrect example in populate_by_name docstring
2 participants
@gbaian10 @Viicos