summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTres Seaver <tseaver@palladion.com>2016-03-24 12:03:08 -0400
committerTres Seaver <tseaver@palladion.com>2016-03-24 12:03:08 -0400
commit3d337183eff2e6c2895dad466776802bfc939870 (patch)
treec4238855317bb5129732827caa6201ccbc77a7ed /docs
parentb9dfacf4c40b02f8130f075d56d25ac80c497278 (diff)
parentf3766c7652cc130598913d74a0b706b26dc71e1f (diff)
downloadzope-interface-3d337183eff2e6c2895dad466776802bfc939870.tar.gz
Merge branch 'doc_tweaks' of https://github.com/msabramo/zope.interface into msabramo-doc_tweaks
Diffstat (limited to 'docs')
-rw-r--r--docs/README.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/README.rst b/docs/README.rst
index 760667d..bb5f9cd 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -21,7 +21,7 @@ see below.
Defining interfaces
===================
-Interfaces are defined using Python class statements:
+Interfaces are defined using Python ``class`` statements:
.. doctest::
@@ -34,11 +34,11 @@ Interfaces are defined using Python class statements:
... def bar(q, r=None):
... """bar blah blah"""
-In the example above, we've created an interface, `IFoo`. We
-subclassed `zope.interface.Interface`, which is an ancestor interface for
+In the example above, we've created an interface, :class:`IFoo`. We
+subclassed :class:`zope.interface.Interface`, which is an ancestor interface for
all interfaces, much as `object` is an ancestor of all new-style
classes [#create]_. The interface is not a class, it's an Interface,
-an instance of `InterfaceClass`:
+an instance of :class:`zope.interface.interface.InterfaceClass`:
.. doctest::