diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/write_hooks.rst | 6 | ||||
-rw-r--r-- | docs/write_plugins.rst | 2 |
2 files changed, 4 insertions, 4 deletions
diff --git a/docs/write_hooks.rst b/docs/write_hooks.rst index dd60367b7..f17e91ce5 100644 --- a/docs/write_hooks.rst +++ b/docs/write_hooks.rst @@ -26,7 +26,7 @@ All Hooks should start with something like this: :: __threaded__ = ["downloadFinished"] __author_name__ = ("Me") __author_mail__ = ("me@has-no-mail.com") - + All meta-data is defined in the header, you need at least one option at ``__config__`` so the user can toggle your hook on and off. Dont't overwrite the ``init`` method if not neccesary, use ``setup`` instead. @@ -117,7 +117,7 @@ Sounds complicated but is very easy to do. Just use the ``Expose`` decorator: :: """ Your Hook code here. """ - + @Expose def invoke(self, arg): print "Invoked with", arg @@ -158,5 +158,5 @@ Usable with: :: Example ------- Sorry but you won't find an example here ;-) - + Look at :file:`module/plugins/hooks` and you will find plenty examples there. diff --git a/docs/write_plugins.rst b/docs/write_plugins.rst index b513a5978..23fda28b6 100644 --- a/docs/write_plugins.rst +++ b/docs/write_plugins.rst @@ -47,7 +47,7 @@ An example ``process`` function could look like this :: """ plugin code """ - + def process(self, pyfile): html = self.load(pyfile.url) # load the content of the orginal pyfile.url to html |