Skip to content

bpo-31567: Use decorator markup for staticmethod()/classmethod() #3959

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Oct 12, 2017
Merged

bpo-31567: Use decorator markup for staticmethod()/classmethod() #3959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c8e4b4
bpo-31567: Use decorator markup for staticmethod()/classmethod()
Oct 7, 2017
9b806c1
Cosmetic edit
merwok Oct 12, 2017
59bc4a7
fix decorator markup
merwok Oct 12, 2017
0c2b39d
Merge pull request #1 from merwok/fix-issue-31567
dmiyakawa Oct 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/library/abc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ The :mod:`abc` module also provides the following decorators:
:func:`abstractmethod`, making this decorator redundant.


.. decorator:: abstractproperty(fget=None, fset=None, fdel=None, doc=None)
.. decorator:: abstractproperty

A subclass of the built-in :func:`property`, indicating an abstract
property.
Expand Down
8 changes: 4 additions & 4 deletions Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,9 @@ are always available. They are listed here in alphabetical order.
base 16). :exc:`ValueError` will be raised if *i* is outside that range.


.. function:: classmethod(function)
.. decorator:: classmethod

Return a class method for *function*.
Transform a method into a class method.

A class method receives the class as implicit first argument, just like an
instance method receives the instance. To declare a class method, use this
Expand Down Expand Up @@ -1398,9 +1398,9 @@ are always available. They are listed here in alphabetical order.

For sorting examples and a brief sorting tutorial, see :ref:`sortinghowto`.

.. function:: staticmethod(function)
.. decorator:: staticmethod

Return a static method for *function*.
Transform a method into a static method.

A static method does not receive an implicit first argument. To declare a static
method, use this idiom::
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/functools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,9 @@ The :mod:`functools` module defines the following functions:
return value


.. decorator:: singledispatch(default)
.. decorator:: singledispatch

Transforms a function into a :term:`single-dispatch <single
Transform a function into a :term:`single-dispatch <single
dispatch>` :term:`generic function`.

To define a generic function, decorate it with the ``@singledispatch``
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/test.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ The :mod:`test.support` module defines the following functions:
otherwise.


.. decorator:: skip_unless_symlink()
.. decorator:: skip_unless_symlink

A decorator for running tests that require support for symbolic links.

Expand Down