Skip to content

bpo-45198: __set_name__ documentation not clear about its usage with non-descriptor classes#28439

Merged
rhettinger merged 3 commits into
python:mainfrom
rhettinger:setname_docs
Sep 18, 2021
Merged

bpo-45198: __set_name__ documentation not clear about its usage with non-descriptor classes#28439
rhettinger merged 3 commits into
python:mainfrom
rhettinger:setname_docs

Conversation

@rhettinger
Copy link
Copy Markdown
Contributor

@rhettinger rhettinger commented Sep 18, 2021 •
edited by bedevere-bot
Loading

  • Change descriptor specific wording and examples to cover the general case.
  • Fix broken example for calling __set_name__ directly. The example was descriptor specific and the invocation could fail because the descriptor would be triggered by the dotted lookup on the class.
  • Move the __set_name__ docs out of the descriptor section and into the general section on class creation.

https://bugs.python.org/issue45198

@rhettinger rhettinger added needs backport to 3.9 needs backport to 3.10 only security fixes skip news docs Documentation in the Doc dir labels Sep 18, 2021
@rhettinger rhettinger merged commit 94b4626 into python:main Sep 18, 2021
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Sep 18, 2021

Thanks @rhettinger for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 18, 2021
@rhettinger @miss-islington
bpo-45198: __set_name__ documentation not clear about its usage with …
f1a54d8 
…non-descriptor classes (pythonGH-28439)

(cherry picked from commit 94b4626)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Sep 18, 2021

Sorry, @rhettinger, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 94b462686b7dfabbd69cc9401037d736d71c4dc2 3.9

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Sep 18, 2021
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Sep 18, 2021

GH-28444 is a backport of this pull request to the 3.10 branch.

miss-islington added a commit that referenced this pull request Sep 18, 2021
@miss-islington @rhettinger
bpo-45198: __set_name__ documentation not clear about its usage with …
7ab114b 
…non-descriptor classes (GH-28439)

(cherry picked from commit 94b4626)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
niyas-sait pushed a commit to niyas-sait/cpython that referenced this pull request Sep 21, 2021
@rhettinger @niyas-sait
bpo-45198: __set_name__ documentation not clear about its usage with …
3de93a8 
…non-descriptor classes (pythonGH-28439)
pablogsal pushed a commit that referenced this pull request Sep 29, 2021
@miss-islington @rhettinger @pablogsal
bpo-45198: __set_name__ documentation not clear about its usage with …
aac54ef 
…non-descriptor classes (GH-28439)

(cherry picked from commit 94b4626)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markshannon markshannon Awaiting requested review from markshannon markshannon is a code owner

Assignees

@rhettinger rhettinger

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@rhettinger @miss-islington @bedevere-bot @the-knights-who-say-ni @ZeroIntensity