Skip to content

Update documentation about @dataclass_transform support #11860

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 4 commits into from
May 20, 2025
Merged

Update documentation about @dataclass_transform support #11860

merged 4 commits into from
May 20, 2025

Conversation

Otto-AA
Copy link
Contributor

@Otto-AA Otto-AA commented May 10, 2025 •
edited
Loading

Change Summary

Since #4241 the finalized PEP 681 is used. This updates the VS Code docs for this. From my understanding, the mypy and Pycharm plugins have custom behaviour instead of relying on this, though I did not look deeply into this.

Related issue number

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

@Otto-AA
Update visual_studio_code.md with finalized PEP 681
594b4d1 
Since pydantic#4241 Pydantic uses the finalized PEP 681 version.
@github-actions github-actions bot added the relnotes-fix Used for bugfixes. label May 10, 2025
@hyperlint-ai Hyperlint AI
Copy link
Contributor

hyperlint-ai bot commented May 10, 2025

PR Change Summary

Updated the Visual Studio Code documentation to reflect the finalized PEP 681.

  • Revised references to PEP 681 to indicate it is a finalized standard.
  • Removed mentions of the draft status of PEP 681.
  • Clarified the role of the standard in enhancing editor support for libraries like Pydantic.

Modified Files

  • docs/integrations/visual_studio_code.md
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@Otto-AA
Copy link
Contributor Author

Otto-AA commented May 10, 2025 •
edited
Loading

please review

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 10, 2025 •
edited
Loading

Coverage report

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

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented May 10, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #11860 will not alter performance

Comparing Otto-AA:patch-1 (50b9d35) with main (53f460c)

Summary

✅ 46 untouched benchmarks

Viicos
Viicos requested changes May 13, 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! Some comments.

@pydantic-hooky pydantic-hooky bot added awaiting author revision awaiting changes from the PR author and removed ready for review labels May 13, 2025
@pydantic-hooky pydantic-hooky bot assigned Otto-AA and unassigned Viicos May 13, 2025
@Viicos Viicos changed the title Update visual_studio_code.md with finalized PEP 681 Update documentation about @dataclass_transform support May 13, 2025
@Viicos Viicos added documentation and removed relnotes-fix Used for bugfixes. labels May 16, 2025
@Otto-AA @Viicos
Update documentation about @dataclass_transform
0bd6abc 
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
@Otto-AA
Copy link
Contributor Author

Otto-AA commented May 19, 2025

Thanks for the feedback, I've added it now.
The "[datetime][datetime.datetime]" is a nice documentation feature, haven't seen it before :)

Viicos
Viicos approved these changes May 20, 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 contribution

@Viicos Viicos merged commit f165eac into pydantic:main May 20, 2025
58 checks passed
@Viicos Viicos added backport-2.11 Needs backport to 2.11 and removed awaiting author revision awaiting changes from the PR author labels May 20, 2025
Viicos added a commit that referenced this pull request May 21, 2025
@Otto-AA @Viicos
Update documentation about @dataclass_transform support
12b371a 
Backport of: #11860
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
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

@Otto-AA Otto-AA

Labels
backport-2.11 Needs backport to 2.11 documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Otto-AA @Viicos