[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces - annotation.py:1.3
Jeremy Hylton
jeremy@zope.com
Mon, 30 Dec 2002 16:14:25 -0500
Update of /cvs-repository/Zope3/src/zope/app/interfaces
In directory cvs.zope.org:/tmp/cvs-serv18142
Modified Files:
annotation.py
Log Message:
docstring normalization
=== Zope3/src/zope/app/interfaces/annotation.py 1.2 => 1.3 ===
--- Zope3/src/zope/app/interfaces/annotation.py:1.2 Wed Dec 25 09:12:56 2002
+++ Zope3/src/zope/app/interfaces/annotation.py Mon Dec 30 16:14:25 2002
@@ -11,7 +11,7 @@
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
-"""
+"""Annotations store arbitrary application data under package-unique keys.
$Id$
"""
@@ -19,10 +19,8 @@
from zope.interface import Interface
from zope.interface import Attribute
-
class IAnnotatable(Interface):
- """
- Marker interface for objects that support storing annotations.
+ """Marker interface for objects that support storing annotations.
This interface says "There exists an adapter to an IAnnotations
for an object that implements IAnnotatable".
@@ -33,39 +31,30 @@
IAttributeAnnotatable.
"""
-
class IAnnotations(IAnnotatable):
- """
- Annotations store arbitrary application data under package unique keys
- """
+ """Stores arbitrary application data under package-unique keys."""
def __getitem__(key):
- """
- Return the annotation stored under key.
+ """Return the annotation stored under key.
Raises KeyError if key not found.
"""
def get(key, default=None):
- """
- Return the annotation stored under key, returning default if not found.
- """
+ """Return the annotation stored under key, or default if not found."""
def __setitem__(key, memento):
- """
- Store annotation under key.
+ """Store annotation under key.
In order to avoid key collisions, users of this interface must
use their dotted package name as part of the key name.
"""
def __delitem__(key):
- """
- Removes the annotation stored under key.
+ """Removes the annotation stored under key.
Raises a KeyError if the key is not found.
"""
-
class IAttributeAnnotatable(IAnnotatable):
"""