Changeset 75

Show
Ignore:
Timestamp:
04-01-2008 18:11:37 (11 months ago)
Author:
s0undt3ch
Message:

Update docstrings.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • sandbox/PylonsGenshi/trunk/pylonsgenshi/decorators.py

    r74 r75  
    4444    the form field errors. 
    4545 
    46     ``template`` 
    47         Refers to the Genshi template to use in case errors need to be shown. 
    48     ``schema`` 
    49         Refers to a FormEncode Schema object to use during validation. 
    50     ``form`` 
    51         Method used to display the form, which will be used to get the 
     46    :param template: Refers to the Genshi template to use in case errors need 
     47                     to be shown. 
     48    :param schema: Refers to a FormEncode Schema object to use during validation. 
     49    :param form: Method used to display the form, which will be used to get the 
    5250        HTML representation of the form for error filling. 
    53     ``variable_decode`` 
    54         Boolean to indicate whether FormEncode's variable decode function 
    55         should be run on the form input before validation. 
    56     ``dict_char`` 
    57         Passed through to FormEncode. Toggles the form field naming 
    58         scheme used to determine what is used to represent a dict. This 
     51    :param variable_decode: Boolean to indicate whether FormEncode's variable 
     52        decode function should be run on the form input before validation. 
     53    :param dict_char: Passed through to FormEncode. Toggles the form field 
     54        naming scheme used to determine what is used to represent a dict. This 
    5955        option is only applicable when used with variable_decode=True. 
    60     ``list_char`` 
    61         Passed through to FormEncode. Toggles the form field naming 
    62         scheme used to determine what is used to represent a list. This 
     56    :param list_char: Passed through to FormEncode. Toggles the form field 
     57        naming scheme used to determine what is used to represent a list. This 
    6358        option is only applicable when used with variable_decode=True. 
    64     ``post_only`` 
    65         Boolean that indicates whether or not GET (query) variables should 
    66         be included during validation. 
     59    :param post_only: Boolean that indicates whether or not GET (query) 
     60        variables should be included during validation. 
    6761 
    6862        .. warning:: 
    … …  
    7064            validated come from. It does *not* restrict the form to only 
    7165            working with post, merely only checking POST vars. 
    72     ``state`` 
    73         Passed through to FormEncode for use in validators that utilize 
    74         a state object. 
    75     ``on_get`` 
    76         Whether to validate on GET requests. By default only POST requests 
     66    :param state: Passed through to FormEncode for use in validators that 
     67        utilize a state object. 
     68    :on_get: Whether to validate on GET requests. By default only POST requests 
    7769        are validated. 
    7870