diff options
| author | Daisuke Miyakawa <d.miyakawa@gmail.com> | 2017-10-12 23:39:43 +0900 |
|---|---|---|
| committer | Éric Araujo <merwok@users.noreply.github.com> | 2017-10-12 10:39:43 -0400 |
| commit | 0e61e67a57deb4abc677808201d7cf3c38138e02 (patch) | |
| tree | 904a042593531964bf0ef25590a34734f86ab508 | |
| parent | 277c84067ff5dfa271725ee9da1a9d75a7c0bcd8 (diff) | |
| download | cpython-git-0e61e67a57deb4abc677808201d7cf3c38138e02.tar.gz | |
bpo-31567: add or fix decorator markup in docs (#3959)
| -rw-r--r-- | Doc/library/abc.rst | 2 | ||||
| -rw-r--r-- | Doc/library/functions.rst | 8 | ||||
| -rw-r--r-- | Doc/library/functools.rst | 4 | ||||
| -rw-r--r-- | Doc/library/test.rst | 2 |
4 files changed, 8 insertions, 8 deletions
diff --git a/Doc/library/abc.rst b/Doc/library/abc.rst index 6001db32df..9522dd6204 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 08093e61fe..eed67301c0 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -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 @@ -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:: diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst index 9a8defee54..28062c1189 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 33978e331b..01ba1ec706 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. |