Improve documentation in interface docstring and doctest.

zopefoundation · Nov 28, 2013 · d45c010 · d45c010
1 parent 8041229
commit d45c010
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/src/z3c/form/browser/radio.txt b/src/z3c/form/browser/radio.txt
@@ -151,6 +151,8 @@ And independently:
    <input id="widget-id-0" name="widget.name" value="true"
           class="hidden-widget" type="hidden" />
 
+The unchecked values do not need a hidden field, hence they are empty:
+
    >>> print(widget.renderForValue('false'))
 
 
@@ -182,6 +184,8 @@ And independently:
    >>> print(widget.renderForValue('true'))
    <span id="widget-id" class="radio-widget"><span class="selected-option">yes</span></span>
 
+Again, unchecked values are not displayed:
+
    >>> print(widget.renderForValue('false'))
 
 

diff --git a/src/z3c/form/interfaces.py b/src/z3c/form/interfaces.py
@@ -580,8 +580,11 @@ class IRadioWidget(ISequenceWidget):
     """Radio widget."""
 
     def renderForValue(value):
-        """Render a single radio button element for a given value"""
+        """Render a single radio button element for a given value.
 
+        Here the word ``value`` is used in the HTML sense, in other
+        words it is a term token.
+        """
 
 class ISubmitWidget(IWidget):
     """Submit widget."""