[Zope3-checkins] CVS: Zope3/lib/python/Zope/Event - IEventService.py:1.4 ISubscribable.py:1.5 ISubscriber.py:1.4 ISubscriptionAware.py:1.3
Steve Alexander
steve@cat-box.net
Mon, 11 Nov 2002 03:33:46 -0500
Update of /cvs-repository/Zope3/lib/python/Zope/Event
In directory cvs.zope.org:/tmp/cvs-serv11799
Modified Files:
IEventService.py ISubscribable.py ISubscriber.py
ISubscriptionAware.py
Log Message:
Minor formatting / typo corrections in docs.
=== Zope3/lib/python/Zope/Event/IEventService.py 1.3 => 1.4 ===
--- Zope3/lib/python/Zope/Event/IEventService.py:1.3 Thu Sep 5 17:41:09 2002
+++ Zope3/lib/python/Zope/Event/IEventService.py Mon Nov 11 03:33:45 2002
@@ -34,7 +34,3 @@
Events will often be propagated to higher level IEventServices;
This is a policy decision for the IEventService.
"""
-
-
-
-
=== Zope3/lib/python/Zope/Event/ISubscribable.py 1.4 => 1.5 ===
--- Zope3/lib/python/Zope/Event/ISubscribable.py:1.4 Mon Oct 21 02:14:47 2002
+++ Zope3/lib/python/Zope/Event/ISubscribable.py Mon Nov 11 03:33:45 2002
@@ -57,9 +57,8 @@
about which subscriber should be notified, and must implement
IEvent. The subscriber will be notified of all events of this
event_type and of subclasses of this event_type.
- The default value, IEvent, as the parent type,
- is effectively a single catch-all event type that will pass all
- event types to the subscriber.
+ The default value, IEvent, as the parent type, is effectively a single
+ catch-all event type that will pass all event types to the subscriber.
filter, if supplied, must implement IEventFilter; subscriber
will be notified of events only if they pass.
@@ -86,7 +85,7 @@
subscriptions for this subscriber are present, no error is
raised.
- if event_type is supplied, this method will unsubscribe the
+ If event_type is supplied, this method will unsubscribe the
subscriber from one subscription exactly matching the
event_type/filter pair given (the default filter being None).
If other subscriptions are present they will remain. If the
@@ -101,8 +100,8 @@
"""
def listSubscriptions(subscriber, event_type=None):
- """returns an iterator of the subscriptions to this channel for
- the subscriber. if event_type is supplied, the list is limited
+ """Returns an iterator of the subscriptions to this channel for
+ the subscriber. If event_type is supplied, the list is limited
to that exact event_type. If the subscribable is a placeful
service, the list will include subscriptions to parent services.
The subscriber is matched via equality (not identity). No
=== Zope3/lib/python/Zope/Event/ISubscriber.py 1.3 => 1.4 ===
--- Zope3/lib/python/Zope/Event/ISubscriber.py:1.3 Tue Sep 3 16:14:00 2002
+++ Zope3/lib/python/Zope/Event/ISubscriber.py Mon Nov 11 03:33:45 2002
@@ -31,7 +31,7 @@
"""
class IIndirectSubscriber(ISubscriber):
- """Interface for objects that handle subscriptions for another object"""
+ """Interface for objects that handle subscriptions for another object."""
def __eq__(other):
"""Compare two indirect subscribers
=== Zope3/lib/python/Zope/Event/ISubscriptionAware.py 1.2 => 1.3 ===
--- Zope3/lib/python/Zope/Event/ISubscriptionAware.py:1.2 Mon Jun 10 19:29:25 2002
+++ Zope3/lib/python/Zope/Event/ISubscriptionAware.py Mon Nov 11 03:33:45 2002
@@ -18,13 +18,13 @@
"""
from Interface import Interface
-# these are calls and not events because they are traditional messages
+# these are method calls and not events because they are traditional messages
# between two objects, not events of general interest.
class ISubscriptionAware(Interface):
def subscribedTo(subscribable, event_type, filter):
- """alerts the object that it has subscribed, via a call from
+ """Alerts the object that it has subscribed, via a call from
itself or from another object, to the subscribable. The
event_type and filter match the arguments provided to the
ISubscribable.subscribe.
@@ -33,11 +33,11 @@
that the global event service will have no wrapping)."""
def unsubscribedFrom(subscribable, event_type, filter):
- """alerts the object that it has unsubscribed, via a call from
+ """Alerts the object that it has unsubscribed, via a call from
itself or from another object, to the subscribable. The
event_type and filter match the exact event_type and filter of
the deleted subscription, rather than, necessarily, the
arguments provided to the ISubscribable.unsubscribe.
The subscribable must be appropriately placefully wrapped (note
- that the global event service will have no wrapping)."""
\ No newline at end of file
+ that the global event service will have no wrapping)."""