Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve weakref_slot docs in dataclasses.rst #123570

Closed
sobolevn opened this issue Sep 1, 2024 · 0 comments
Closed

Improve weakref_slot docs in dataclasses.rst #123570

sobolevn opened this issue Sep 1, 2024 · 0 comments
Assignees
Labels
docs Documentation in the Doc dir topic-dataclasses

Comments

@sobolevn
Copy link
Member

sobolevn commented Sep 1, 2024

While merging #123342 I've noticed that we can improve weakref_slot docs. Here's how it looks now:
Снимок экрана 2024-09-01 в 13 53 28

I think that we can add a link to weakref.ref under "weakref-able" term. Like this:
Снимок экрана 2024-09-01 в 13 55 34

Right now dataclass.rst does not have a single link to weakref.rst. This change will make it easier for users to navigate to this term, which not all people are familiar with.

Linked PRs

@sobolevn sobolevn added docs Documentation in the Doc dir topic-dataclasses labels Sep 1, 2024
@sobolevn sobolevn self-assigned this Sep 1, 2024
sobolevn added a commit to sobolevn/cpython that referenced this issue Sep 1, 2024
sobolevn added a commit that referenced this issue Sep 2, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 2, 2024
…n `dataclasses` (pythonGH-123571)

(cherry picked from commit c3ed775)

Co-authored-by: sobolevn <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 2, 2024
…n `dataclasses` (pythonGH-123571)

(cherry picked from commit c3ed775)

Co-authored-by: sobolevn <[email protected]>
sobolevn added a commit that referenced this issue Sep 2, 2024
…in `dataclasses` (GH-123571) (#123595)

gh-123570: Add link to `weakref.ref` from `weakref_slot` docs in `dataclasses` (GH-123571)
(cherry picked from commit c3ed775)

Co-authored-by: sobolevn <[email protected]>
Yhg1s pushed a commit that referenced this issue Sep 2, 2024
…in `dataclasses` (GH-123571) (#123594)

gh-123570: Add link to `weakref.ref` from `weakref_slot` docs in `dataclasses` (GH-123571)
(cherry picked from commit c3ed775)

Co-authored-by: sobolevn <[email protected]>
@sobolevn sobolevn closed this as completed Sep 3, 2024
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 topic-dataclasses
Projects
None yet
Development

No branches or pull requests

1 participant