summaryrefslogtreecommitdiff
path: root/docs/api/common.rst
diff options
context:
space:
mode:
authorJason Madden <jamadden@gmail.com>2020-02-13 11:05:11 -0600
committerJason Madden <jamadden@gmail.com>2020-02-17 07:02:57 -0600
commitd088fd500d8aa03a7629c9a700685bf41c9dbf19 (patch)
treed92ce44ff3325a66a1536b388b01f2b9cf79709f /docs/api/common.rst
parent4faeef1fe809cc818027f3402e65f9e1e1ce0c58 (diff)
downloadzope-interface-d088fd500d8aa03a7629c9a700685bf41c9dbf19.tar.gz
Update documentation and clarify the relationship of the older mapping and sequence interfaces.
Diffstat (limited to 'docs/api/common.rst')
-rw-r--r--docs/api/common.rst32
1 files changed, 17 insertions, 15 deletions
diff --git a/docs/api/common.rst b/docs/api/common.rst
index 498d1dc..36d1d3f 100644
--- a/docs/api/common.rst
+++ b/docs/api/common.rst
@@ -4,29 +4,19 @@
The ``zope.interface.common`` package provides interfaces for objects
distributed as part of the Python standard library. Importing these
-modules has the effect of making the standard library objects
+modules (usually) has the effect of making the standard library objects
implement the correct interface.
-``zope.interface.common.interfaces``
-====================================
+zope.interface.common.interface
+===============================
.. automodule:: zope.interface.common.interfaces
-``zope.interface.common.idatetime``
-===================================
+zope.interface.common.idatetime
+===============================
.. automodule:: zope.interface.common.idatetime
-``zope.interface.common.mapping``
-=================================
-
-.. automodule:: zope.interface.common.mapping
-
-``zope.interface.common.sequence``
-==================================
-
-.. automodule:: zope.interface.common.sequence
-
zope.interface.common.collections
=================================
@@ -46,3 +36,15 @@ zope.interface.common.io
========================
.. automodule:: zope.interface.common.io
+
+.. Deprecated or discouraged modules below this
+
+zope.interface.common.mapping
+=============================
+
+.. automodule:: zope.interface.common.mapping
+
+zope.interface.common.sequence
+==============================
+
+.. automodule:: zope.interface.common.sequence