changeset 241:d082511f6a3b

fixed doc strings
author Reimar Bauer <rb.proj AT googlemail DOT com>
date Tue, 02 Sep 2008 11:39:49 +0200
parents 7bf57812a894
children db18e0d98dd0
files data/plugin/action/arnica_slides.py data/plugin/parser/text_x_arnica.py
diffstat 2 files changed, 15 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/data/plugin/action/arnica_slides.py	Tue Sep 02 11:32:01 2008 +0200
+++ b/data/plugin/action/arnica_slides.py	Tue Sep 02 11:39:49 2008 +0200
@@ -322,7 +322,9 @@
         return None
 
     def slide_show(self, pagename):
-        """ run the slide show """
+        """ run the slide show
+        @param pagename: name of the page the slideshow is based on 
+        """
         _ = self.request.getText
         request = self.request
         if not request.user.may.read(pagename):
--- a/data/plugin/parser/text_x_arnica.py	Tue Sep 02 11:32:01 2008 +0200
+++ b/data/plugin/parser/text_x_arnica.py	Tue Sep 02 11:39:49 2008 +0200
@@ -204,7 +204,6 @@
 
     def html_tools(self, idx):
         """ html code of thumbnails view with contol
-
         @param idx: index position of corresponding data
         """
 
@@ -252,7 +251,9 @@
         return html
 
     def html_show_tools(self, idx):
-        """ shows toolbox """
+        """ shows toolbox
+        @param idx: index position of corresponding data
+        """
 
         html = ''
         if self.show_tools:
@@ -262,7 +263,9 @@
         return html
 
     def html_show_date(self, idx):
-        """ shows date """
+        """ shows date
+        @param idx: index position of corresponding data
+        """
 
         html = ''
         if self.show_date:
@@ -271,7 +274,9 @@
         return html
 
     def html_show_alias(self, idx):
-        """ view mode 1 alias text below image """
+        """ alias text below image
+        @param idx: index position of corresponding data
+        """
 
         html = ''
         if self.show_text:
@@ -280,7 +285,9 @@
         return html
 
     def html_arrange_thumbnails(self, idx):
-        """ defines arrangement of thumbnail, text, date and tools """
+        """ defines arrangement of thumbnail, text, date and tools
+        @param idx: index positionn of corresponding data
+        """
 
         title = ""
         if self.album:
@@ -353,7 +360,6 @@
 
     def to_wikitext(self, text):
         """ converts text to wiki name if it is written as WikiName or [[wikiname]]
-
         @param text: text to parse and render
         """
         text = ''.join(text)