Skip to content

gh-91362: reword pickle docs to account for nested classes#92429

Merged
JelleZijlstra merged 2 commits intopython:mainfrom
hauntsaninja:pickldoc
May 21, 2022
Merged

gh-91362: reword pickle docs to account for nested classes#92429
JelleZijlstra merged 2 commits intopython:mainfrom
hauntsaninja:pickldoc

Conversation

@hauntsaninja
Copy link
Contributor

@hauntsaninja hauntsaninja commented May 7, 2022

I'm not sure this is the best wording.

Alternatives include:

  • accessible via attribute access on the containing module
  • not in a local namespace

#91362

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 7, 2022
@hauntsaninja hauntsaninja changed the title gh-91362: reword docs to better account for nested classes gh-91362: reword pickle docs to better account for nested classes May 7, 2022
@hauntsaninja hauntsaninja changed the title gh-91362: reword pickle docs to better account for nested classes gh-91362: reword pickle docs to account for nested classes May 7, 2022
@JelleZijlstra
Copy link
Member

Maybe add something around line 522 where it says "This means that only the function name is pickled, along with the name of the module the function is defined in." That sentence is inaccurate for nested functions or methods. We can also link to https://docs.python.org/3/glossary.html#term-qualified-name.

@JelleZijlstra JelleZijlstra self-assigned this May 8, 2022
@miss-islington
Copy link
Contributor

Thanks @hauntsaninja for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 21, 2022
…honGH-92429)

Fixes pythonGH-91362
(cherry picked from commit f9d6c59)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@bedevere-bot
Copy link

GH-93053 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 May 21, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 21, 2022
…honGH-92429)

Fixes pythonGH-91362
(cherry picked from commit f9d6c59)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label May 21, 2022
@bedevere-bot
Copy link

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

miss-islington added a commit that referenced this pull request May 21, 2022
Fixes GH-91362
(cherry picked from commit f9d6c59)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
miss-islington added a commit that referenced this pull request May 21, 2022
Fixes GH-91362
(cherry picked from commit f9d6c59)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@hauntsaninja hauntsaninja deleted the pickldoc branch May 22, 2022 07:59
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants