cc-4105: a whole bunch of docstrings were added

This commit is contained in:
Rudi Grinberg 2012-08-13 15:24:45 -04:00
parent 6238424113
commit 5d33ca7c6f
8 changed files with 57 additions and 7 deletions

View file

@ -33,7 +33,7 @@ class EventRegistry(object):
return event
def __init__(self,*args,**kwargs):
raise Exception("You can instantiate this class. Must only use class \
methods")
methods")
class HasMetaData(object):
"""
@ -70,7 +70,12 @@ class BaseEvent(Loggable):
return "Event(%s). Path(%s)" % ( self.path, self.__class__.__name__)
def is_dir_event(self): return self._raw_event.dir
def add_safe_pack_hook(self,k): self._pack_hook = k
def add_safe_pack_hook(self,k):
"""
adds a callable object (function) that will be called after the event
has been "safe_packed"
"""
self._pack_hook = k
# As opposed to unsafe_pack...
def safe_pack(self):