NotificationsYou must be signed in to change notification settings
Fork32.4k
Star67.9k

Improve docs for`typing.dataclass_transform`#105792

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

AlexWaygood merged 1 commit intopython:mainfromAlexWaygood:dataclass-transform-docs

Jun 15, 2023

Merged

Improve docs for`typing.dataclass_transform`#105792

AlexWaygood merged 1 commit intopython:mainfromAlexWaygood:dataclass-transform-docs

Jun 15, 2023

Conversation

Copy link

Member

AlexWaygood commentedJun 14, 2023•
edited by github-actionsbot
Loading

Document the function signature in the header
Use a Sphinx parameter list to document the meaning of each parameter
Use a table to document the accepted parameters for field specifiers

📚 Documentation preview 📚:https://cpython-previews--105792.org.readthedocs.build/

Improve docs fortyping.dataclass_transform

43a6dd1

AlexWaygood added skip issue skip news topic-typing labels

Jun 14, 2023

AlexWaygood requested a review fromerlend-aasland

June 14, 2023 16:05

AlexWaygood requested review fromgvanrossum,Fidget-Spinner andJelleZijlstra ascode owners

June 14, 2023 16:05

bedevere-bot added awaiting core review docsDocumentation in the Doc dir labels

Jun 14, 2023

AlexWaygood added needs backport to 3.11

only security fixes

needs backport to 3.12only security fixes labels

Jun 14, 2023

Copy link

MemberAuthor

AlexWaygood commentedJun 14, 2023

Old:https://docs.python.org/3.13/library/typing.html#typing.dataclass_transform

New:https://cpython-previews--105792.org.readthedocs.build/en/105792/library/typing.html#typing.dataclass_transform

JelleZijlstra approved these changes

Jun 15, 2023

View reviewed changes

Doc/library/typing.rst

		:header-rows: 1
		:widths: 20 80

		* - Parameter name

Copy link

Member

JelleZijlstraJun 15, 2023

Choose a reason for hiding this comment

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

wow, didn't know you could write tables this way. That's much easier than laying it out manually

Copy link

MemberAuthor

AlexWaygoodJun 15, 2023

Choose a reason for hiding this comment

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

Yeah, I learned about this pretty recently too!

Copy link

Contributor

erlend-aaslandJun 15, 2023

Choose a reason for hiding this comment

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

This is neat! TIL

bedevere-bot added awaiting merge and removed awaiting core review labels

Jun 15, 2023

AlexWaygood merged commit006a453 intopython:main

Jun 15, 2023

Copy link

Contributor

miss-islington commentedJun 15, 2023

Thanks@AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

bedevere-bot removed the awaiting merge label

Jun 15, 2023

AlexWaygood deleted the dataclass-transform-docs branch

June 15, 2023 05:51

Copy link

Contributor

miss-islington commentedJun 15, 2023

Sorry,@AlexWaygood, I could not cleanly backport this to3.11 due to a conflict.
Please backport usingcherry_picker on command line.
cherry_picker 006a4532058f1fadba93283c0f45b0d82735b364 3.11

miss-islington assignedAlexWaygood

Jun 15, 2023

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Jun 15, 2023

Improve docs fortyping.dataclass_transform(pythonGH-105792)

02b47cd

(cherry picked from commit006a453)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Copy link

bedevere-bot commentedJun 15, 2023

GH-105809 is a backport of this pull request to the3.12 branch.

bedevere-bot removed the needs backport to 3.12only security fixes label

Jun 15, 2023

AlexWaygood added a commit that referenced this pull request

Jun 15, 2023

[3.12] Improve docs fortyping.dataclass_transform(GH-105792) (#10…

1573f16

…5809)Improve docs for `typing.dataclass_transform` (GH-105792)(cherry picked from commit006a453)Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

erlend-aasland reviewed

Jun 15, 2023

View reviewed changes

Doc/library/typing.rstShow resolvedHide resolved

Copy link

Contributor

erlend-aasland commentedJun 15, 2023

Very nice improvement! LGTM

Copy link

MemberAuthor

AlexWaygood commentedJun 15, 2023

Thanks@erlend-aasland!

erlend-aasland mentioned this pull request

Jun 15, 2023

Docs: make it easier to reference and markup decorators#105812

Open

AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request

Jun 15, 2023

[3.11] Improve docs fortyping.dataclass_transform(python#105792)

1bddb6a

(cherry-picked from commit006a453)

Copy link

bedevere-bot commentedJun 15, 2023

GH-105815 is a backport of this pull request to the3.11 branch.

bedevere-bot removed the needs backport to 3.11only security fixes label

Jun 15, 2023

AlexWaygood added a commit that referenced this pull request

Jun 15, 2023

[3.11] Improve docs fortyping.dataclass_transform(#105792) (#105815)

c197bd8

(cherry-picked from commit006a453)

carljm added a commit to carljm/cpython that referenced this pull request

Jun 15, 2023

Merge branch 'main' into modulelocals

166aca9

* main: (57 commits)pythongh-105831: Fix NEWS blurb frompythongh-105828 (python#105833)pythongh-105820: Fix tok_mode expression buffer in file & readline tokenizer (python#105828)pythongh-105751, test_ctypes: Remove disabled tests (python#105826)pythongh-105821: Use a raw f-string in test_httpservers.py (python#105822)pythongh-105751: Remove platform usage in test_ctypes (python#105819)pythongh-105751: Reenable disable test_ctypes tests (python#105818)pythongh-105751: Remove dead code in test_ctypes (python#105817)  More reorganisation of the typing docs (python#105787)  Improve docs for `typing.dataclass_transform` (python#105792)pythonGH-89812: Churn `pathlib.Path` test methods (python#105807)pythongh-105800: Issue SyntaxWarning in f-strings for invalid escape sequences (python#105801)pythongh-105751: Cleanup test_ctypes imports (python#105803)pythongh-105481: add HAS_JUMP flag to opcode metadata (python#105791)pythongh-105751: test_ctypes avoids the operator module (pythonGH-105797)pythongh-105751: test_ctypes: Remove @need_symbol decorator (pythonGH-105798)pythongh-104909: Implement conditional stack effects for macros (python#105748)pythongh-75905: Remove test_xmlrpc_net: skipped since 2017 (python#105796)pythongh-105481: Fix types and a bug for pseudos (python#105788)  Update DSL docs for cases generator (python#105753)pythonGH-77273: Better bytecodes for f-strings (pythonGH-6132)  ...