Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

Commit

Permalink
Update doc strings to ReST
Browse files Browse the repository at this point in the history
  • Loading branch information
Phil Ruggera committed Sep 2, 2004
1 parent 2dcfdee commit 28e9cc0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 4 additions & 2 deletions __init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
$Id$
"""
__docformat__ = 'restructuredtext'

from interfaces import IDependable
from zope.app.annotation.interfaces import IAnnotations
from zope.app.traversing.api import getParent, canonicalPath, getPath
Expand All @@ -25,7 +27,7 @@ class PathSetAnnotation(object):
"""Abstract base class for annotations that are sets of paths.
To make this into a concrete class, a subclass must set the class
attribute 'key' to a unique annotation key. A subclass may also
attribute `key` to a unique annotation key. A subclass may also
choose to rename the methods.
"""

Expand Down Expand Up @@ -90,7 +92,7 @@ def _make_absolute(self, path):


class Dependable(PathSetAnnotation):
"""See IDependable."""
"""See `IDependable`."""

implements(IDependable)

Expand Down
4 changes: 3 additions & 1 deletion interfaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@
$Id$
"""
__docformat__ = 'restructuredtext'

from zope.interface import Interface
from zope.app.exception.interfaces import UserError

class IDependable(Interface):
"""Objects that other objects depend on.
Note that IDependable will normally be implemented by an adapter.
Note that `IDependable` will normally be implemented by an adapter.
"""

def addDependent(location):
Expand Down

0 comments on commit 28e9cc0

Please sign in to comment.