Skip to content

Commit

Permalink
bpo-34085: Improve wording on classmethod/staticmethod (GH-8228)
Browse files Browse the repository at this point in the history
* bpo-34085: Improve wording on classmethod/staticmethod

* Address comments from Éric

* Address comments from Éric
(cherry picked from commit 548cb60)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
  • Loading branch information
miss-islington and andresdelfino committed Mar 25, 2019
1 parent 0516f81 commit bd96393
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions Doc/library/functions.rst
Expand Up @@ -175,19 +175,18 @@ section.
def f(cls, arg1, arg2, ...):
...

The ``@classmethod`` form is a function :term:`decorator` -- see the description
of function definitions in :ref:`function` for details.
The ``@classmethod`` form is a function :term:`decorator` -- see
:ref:`function` for details.

It can be called either on the class (such as ``C.f()``) or on an instance (such
A class method can be called either on the class (such as ``C.f()``) or on an instance (such
as ``C().f()``). The instance is ignored except for its class. If a class
method is called for a derived class, the derived class object is passed as the
implied first argument.

Class methods are different than C++ or Java static methods. If you want those,
see :func:`staticmethod` in this section.
see :func:`staticmethod`.

For more information on class methods, consult the documentation on the standard
type hierarchy in :ref:`types`.
For more information on class methods, see :ref:`types`.

.. versionadded:: 2.2

Expand Down Expand Up @@ -1346,18 +1345,17 @@ section.
def f(arg1, arg2, ...):
...

The ``@staticmethod`` form is a function :term:`decorator` -- see the
description of function definitions in :ref:`function` for details.
The ``@staticmethod`` form is a function :term:`decorator` -- see
:ref:`function` for details.

It can be called either on the class (such as ``C.f()``) or on an instance (such
as ``C().f()``). The instance is ignored except for its class.
A static method can be called either on the class (such as ``C.f()``) or on an instance (such
as ``C().f()``).

Static methods in Python are similar to those found in Java or C++. Also see
:func:`classmethod` for a variant that is useful for creating alternate
class constructors.

For more information on static methods, consult the documentation on the
standard type hierarchy in :ref:`types`.
For more information on static methods, see :ref:`types`.

.. versionadded:: 2.2

Expand Down

0 comments on commit bd96393

Please sign in to comment.