Code

Ticket #6674: widget-doc.diff

File widget-doc.diff, 979 bytes (added by timo, 5 years ago)

documentation for render_doc and check_test

Line 
1Index: docs/ref/forms/widgets.txt
2===================================================================
3--- docs/ref/forms/widgets.txt  (revision 10334)
4+++ docs/ref/forms/widgets.txt  (working copy)
5@@ -24,6 +24,13 @@
6 
7     Password input: ``<input type='password' ...>``
8 
9+    Takes one optional argument:
10+
11+    .. attribute:: PasswordInput.render_value
12+
13+        Determines whether the widget will have a value filled in when the
14+        form is re-displayed after a validation error (default is ``True``).
15+
16 .. class:: HiddenInput
17 
18     Hidden input: ``<input type='hidden' ...>``
19@@ -87,6 +94,14 @@
20 
21     Checkbox: ``<input type='checkbox' ...>``
22 
23+    Takes one optional argument:
24+
25+    .. attribute:: CheckboxInput.check_test
26+     
27+        A callable that takes the value of the CheckBoxInput
28+        and returns ``True`` if the checkbox should be checked for
29+        that value.
30+
31 .. class:: Select
32 
33     Select widget: ``<select><option ...>...</select>``