summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-10-21 10:32:54 +0000
committerGeorg Brandl <georg@python.org>2007-10-21 10:32:54 +0000
commit5c174bbd845fb9da880b9ab1c9d5da0280cc880f (patch)
treed3fbcc8352c69026f6d2f324684190da91078127
parent63fa16832617bfad010e3e70e7f10f713afd7593 (diff)
downloadcpython-git-5c174bbd845fb9da880b9ab1c9d5da0280cc880f.tar.gz
Add markup to new function descriptions.
-rw-r--r--Doc/library/inspect.rst37
1 files changed, 19 insertions, 18 deletions
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 7e95eeead2..2c8041d9b5 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -265,30 +265,31 @@ Note:
.. function:: ismethoddescriptor(object)
- Return true if the object is a method descriptor, but not if ismethod() or
- isclass() or isfunction() are true.
+ Return true if the object is a method descriptor, but not if :func:`ismethod`
+ or :func:`isclass` or :func:`isfunction` are true.
- This is new as of Python 2.2, and, for example, is true of int.__add__. An
- object passing this test has a __get__ attribute but not a __set__ attribute,
- but beyond that the set of attributes varies. __name__ is usually sensible, and
- __doc__ often is.
+ This is new as of Python 2.2, and, for example, is true of
+ ``int.__add__``. An object passing this test has a :attr:`__get__` attribute
+ but not a :attr:`__set__` attribute, but beyond that the set of attributes
+ varies. :attr:`__name__` is usually sensible, and :attr:`__doc__` often is.
- Methods implemented via descriptors that also pass one of the other tests return
- false from the ismethoddescriptor() test, simply because the other tests promise
- more -- you can, e.g., count on having the im_func attribute (etc) when an
- object passes ismethod().
+ Methods implemented via descriptors that also pass one of the other tests
+ return false from the :func:`ismethoddescriptor` test, simply because the
+ other tests promise more -- you can, e.g., count on having the
+ :attr:`im_func` attribute (etc) when an object passes :func:`ismethod`.
.. function:: isdatadescriptor(object)
Return true if the object is a data descriptor.
- Data descriptors have both a __get__ and a __set__ attribute. Examples are
- properties (defined in Python), getsets, and members. The latter two are
- defined in C and there are more specific tests available for those types, which
- is robust across Python implementations. Typically, data descriptors will also
- have __name__ and __doc__ attributes (properties, getsets, and members have both
- of these attributes), but this is not guaranteed.
+ Data descriptors have both a :attr:`__get__` and a :attr:`__set__` attribute.
+ Examples are properties (defined in Python), getsets, and members. The
+ latter two are defined in C and there are more specific tests available for
+ those types, which is robust across Python implementations. Typically, data
+ descriptors will also have :attr:`__name__` and :attr:`__doc__` attributes
+ (properties, getsets, and members have both of these attributes), but this is
+ not guaranteed.
.. versionadded:: 2.3
@@ -309,8 +310,8 @@ Note:
Return true if the object is a member descriptor.
Member descriptors are attributes defined in extension modules via
- ``PyMemberDef`` structures. For Python implementations without such types, this
- method will always return ``False``.
+ ``PyMemberDef`` structures. For Python implementations without such types,
+ this method will always return ``False``.
.. versionadded:: 2.5