Commits

ZyX_I committed 685acab

Moved checker and filter descriptions outside of addextfunctions() description

  • Participants
  • Parent commits 4141659

Comments (0)

Files changed (1)

         {funcdescr} must be a dictionary with the following keys:
         Key        Description ~
         function   Function reference. Determines function that will be called.
-        checker    If `checker' value is a function reference, then each time 
-                   wrapper function is called its arguments will be passed as 
-                   a single list to a checker. Checker then must return either 
-                   one indicating that check passed or zero indicating that 
-                   `checkfailed' exception must be thrown.
-        filter     Like `checker', but it must return either list (it will be 
-                   passed to a `function' then) or 0 (throws `filterfailed' 
-                   exception). If both `checker' and `filter' are present, then 
-                   `checker' is used first.
+        checker    See |frawor-t-checker|. Throws `checkfailed' exception if 
+                   check fails.
+        filter     See |frawor-t-filter|. Throws `filterfailed' exception if 
+                   filtering fails.
+                   If both `checker' and `filter' are present, then `checker' is 
+                   used first.
         altervars  List of lists [({varname}, {value})]. If this key is present 
                    before `function' is called all variables with given names 
                    will be assigned corresponding {value}s and their values will 
                       |FraworRegister()|).
         g             Dictionary with global variables (last but one argument to 
                       |FraworRegister()|).
+checker :: Function                                           *frawor-t-checker*
+        If checker is a function reference, then in order to check arguments 
+        this function will be called with an argument list as an only 
+        argument. Check is considered passed when this function returns 1 and 
+        failed when this function returns 0.
+filter :: Function                                             *frawor-t-filter*
+        If filter is a function reference, then in order to filter arguments 
+        this function will be called with an argument list as an only argument. 
+        If function returns a |List|, then it will be used as a new argument 
+        list. Function should return 0 if some error occured.
 
 vim: ft=help:tw=78