# HG changeset patch
# User Thierry Florac <thierry.florac@onf.fr>
# Date 1497881108 -7200
# Node ID 39095d40c406929f96ebaeeb648e26e8443af5a7
# Parent  bf448402f41d39ab619b5d1a809c8daa3c01216f
Updated docstrings and doctests

diff -r bf448402f41d -r 39095d40c406 src/pyams_utils/dict.py
--- a/src/pyams_utils/dict.py	Mon Jun 19 15:54:58 2017 +0200
+++ b/src/pyams_utils/dict.py	Mon Jun 19 16:05:08 2017 +0200
@@ -21,6 +21,34 @@
 
 
 def update_dict(input, key, value):
-    """Update given mapping if input value is not null"""
+    """Update given mapping if input value is a boolean 'true' value
+
+    :param dict input: input dictionary
+    :param key: mapping key
+    :param value: new value
+
+    'False' values leave mapping unchanged::
+
+    >>> from pyams_utils.dict import update_dict
+    >>> mydict = {}
+    >>> update_dict(mydict, 'key1', None)
+    >>> mydict
+    {}
+    >>> update_dict(mydict, 'key1', '')
+    >>> mydict
+    {}
+    >>> update_dict(mydict, 'key1', 0)
+    >>> mydict
+    {}
+
+    'True' values modify the mapping::
+
+    >>> update_dict(mydict, 'key1', 'value')
+    >>> mydict
+    {'key1': 'value'}
+    >>> update_dict(mydict, 'key1', 'value2')
+    >>> mydict
+    {'key1': 'value2'}
+    """
     if value:
         input[key] = value