Skip to content

gh-152361: Add module docstring to dataclasses#152372

Closed
zainnadeem786 wants to merge 1 commit into
python:mainfrom
zainnadeem786:docs/dataclasses-module-docstring
Closed

gh-152361: Add module docstring to dataclasses#152372
zainnadeem786 wants to merge 1 commit into
python:mainfrom
zainnadeem786:docs/dataclasses-module-docstring

Conversation

@zainnadeem786

Copy link
Copy Markdown
Contributor

Summary

Add a module-level docstring to dataclasses so that help(dataclasses) displays a useful module description instead of relying only on the automatically generated documentation.

Changes

  • Add a concise module docstring to Lib/dataclasses.py.
  • No runtime behavior or public API changes.

Validation

Executed:

PCbuild\amd64\python_d.exe -c "import dataclasses; help(dataclasses)"
PCbuild\amd64\python_d.exe -m test test_dataclasses
git diff --check

All tests passed.

Closes gh-152361.

@aiwonderland

Copy link
Copy Markdown

wow

@picnixz

picnixz commented Jun 27, 2026

Copy link
Copy Markdown
Member

I don't think it's necessary. Please in the future, don't open PRs until it's been acknowledged by a triager or core developer as a necessary feature.

@picnixz picnixz closed this Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add main docstring for std module dataclasses

3 participants