Skip to content

Glossary: "method" - improve formatting#144714

Open
wjandrea wants to merge 5 commits intopython:mainfrom
wjandrea:patch-3
Open

Glossary: "method" - improve formatting#144714
wjandrea wants to merge 5 commits intopython:mainfrom
wjandrea:patch-3

Conversation

@wjandrea
Copy link
Copy Markdown
Contributor

@wjandrea wjandrea commented Feb 11, 2026 •
edited
Loading

  • Move up "function" link
  • Add links to "class" and "attribute"
  • Use consistent "See also"

From:

method

A function which is defined inside a class body. If called as an attribute of an instance of that class, the method will get the instance object as its first argument (which is usually called self). See function and nested scope.

To:

method

A function which is defined inside a class body. If called as an attribute of an instance of that class, the method will get the instance object as its first argument (which is usually called self).

See also nested scope.

📚 Documentation preview 📚: https://cpython-previews--144714.org.readthedocs.build/

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Feb 11, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Feb 11, 2026
@wjandrea wjandrea marked this pull request as ready for review February 11, 2026 16:50
picnixz
picnixz reviewed Mar 7, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to add a reference to class actually. We don't link it for metaclass for instance, which would make more sense IMO and it doesn't strike as being necessary in this case. But I'm ok with removing the "See function" and only keep the "nested scope".

Comment thread Doc/glossary.rst
will get the instance object as its first :term:`argument` (which is
usually called ``self``).

See also :term:`nested scope`.
Copy link
Copy Markdown
Member

@picnixz picnixz Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most entries have their "See also" either in a separate paragraph or at the end of the sentence (e.g., "mutable" has lots of small terms at the end) so I think you can also keep the "nested scope" in the same paragraph (the "function" entry also inlines its "see also" sentence).

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label May 6, 2026
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 7, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #32583036 | 📁 Comparing 0f3e522 against main (b3cfd36)

  🔍 Preview build  

1 file changed
± glossary.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz left review comments

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip issue skip news stale Stale PR or inactive for long period of time.

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@wjandrea @picnixz @StanFromIreland