◐ Shell
reader mode source ↗
Skip to content

Improve docs for typing.dataclass_transform#105792

Merged
AlexWaygood merged 1 commit into
python:mainfrom
AlexWaygood:dataclass-transform-docs
Jun 15, 2023
Merged

Improve docs for typing.dataclass_transform#105792
AlexWaygood merged 1 commit into
python:mainfrom
AlexWaygood:dataclass-transform-docs

Conversation

@AlexWaygood

@AlexWaygood AlexWaygood commented Jun 14, 2023

Copy link
Copy Markdown
Member
  • 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/

@miss-islington

Copy link
Copy Markdown
Contributor

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

@AlexWaygood AlexWaygood deleted the dataclass-transform-docs branch June 15, 2023 05:51
@miss-islington

Copy link
Copy Markdown
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 15, 2023
(cherry picked from commit 006a453)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-bot

Copy link
Copy Markdown

GH-105809 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jun 15, 2023
AlexWaygood added a commit that referenced this pull request Jun 15, 2023
…5809)

Improve docs for `typing.dataclass_transform` (GH-105792)
(cherry picked from commit 006a453)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@erlend-aasland

Copy link
Copy Markdown
Contributor

Very nice improvement! LGTM

@AlexWaygood

Copy link
Copy Markdown
Member Author

Thanks @erlend-aasland!

AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Jun 15, 2023
@bedevere-bot

Copy link
Copy Markdown

GH-105815 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jun 15, 2023
AlexWaygood added a commit that referenced this pull request Jun 15, 2023
carljm added a commit to carljm/cpython that referenced this pull request Jun 15, 2023
* main: (57 commits)
  pythongh-105831: Fix NEWS blurb from pythongh-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)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news topic-typing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants