diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2017-10-12 16:33:05 (GMT) |
---|---|---|
committer | Éric Araujo <merwok@users.noreply.github.com> | 2017-10-12 16:33:05 (GMT) |
commit | 205dd4e14de77f9c8ed2903ddebbcf9968bbb6a9 (patch) | |
tree | 149334cae0030e9085be8c81a0b05fc2cadb7c67 /Doc/library | |
parent | 5f908005ce16b06d5af7b413264009c4b062f33c (diff) | |
download | cpython-205dd4e14de77f9c8ed2903ddebbcf9968bbb6a9.zip cpython-205dd4e14de77f9c8ed2903ddebbcf9968bbb6a9.tar.gz cpython-205dd4e14de77f9c8ed2903ddebbcf9968bbb6a9.tar.bz2 |
[3.6] bpo-31567: add or fix decorator markup in docs (GH-3959) (GH-3966)
(cherry picked from commit 0e61e67a57deb4abc677808201d7cf3c38138e02)
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/abc.rst | 2 | ||||
-rw-r--r-- | Doc/library/functions.rst | 21 | ||||
-rw-r--r-- | Doc/library/functools.rst | 4 | ||||
-rw-r--r-- | Doc/library/test.rst | 2 | ||||
-rw-r--r-- | Doc/library/typing.rst | 6 |
5 files changed, 22 insertions, 13 deletions
diff --git a/Doc/library/abc.rst b/Doc/library/abc.rst index 6001db3..9522dd6 100644 --- a/Doc/library/abc.rst +++ b/Doc/library/abc.rst @@ -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. diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index bd4c94f..7a7a84d 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -182,9 +182,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 @@ -1384,9 +1384,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:: @@ -1405,12 +1405,21 @@ are always available. They are listed here in alphabetical order. :func:`classmethod` for a variant that is useful for creating alternate class constructors. + Like all decorators, it is also possible to call ``staticmethod`` as + a regular function and do something with its result. This is needed + in some cases where you need a reference to a function from a class + body and you want to avoid the automatic transformation to instance + method. For these cases, use this idiom: + + class C: + builtin_open = staticmethod(open) + For more information on static methods, consult the documentation on the standard type hierarchy in :ref:`types`. - .. index:: - single: string; str() (built-in function) +.. index:: + single: string; str() (built-in function) .. _func-str: .. class:: str(object='') diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst index 9a8defe..28062c1 100644 --- a/Doc/library/functools.rst +++ b/Doc/library/functools.rst @@ -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`` diff --git a/Doc/library/test.rst b/Doc/library/test.rst index 9d4ff7a..1a3f8f9 100644 --- a/Doc/library/test.rst +++ b/Doc/library/test.rst @@ -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. diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index bd04f73..9883d8b 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -897,17 +897,17 @@ The module defines the following classes, functions and decorators: See :pep:`484` for details and comparison with other typing semantics. -.. decorator:: no_type_check(arg) +.. decorator:: no_type_check Decorator to indicate that annotations are not type hints. - The argument must be a class or function; if it is a class, it + This works as class or function :term:`decorator`. With a class, it applies recursively to all methods defined in that class (but not to methods defined in its superclasses or subclasses). This mutates the function(s) in place. -.. decorator:: no_type_check_decorator(decorator) +.. decorator:: no_type_check_decorator Decorator to give another decorator the :func:`no_type_check` effect. |