minor doc

kpe · Mar 22, 2019 · 0a8fdf3 · 0a8fdf3
1 parent 0200b49
commit 0a8fdf3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/params/__init__.py b/params/__init__.py
@@ -5,4 +5,4 @@
 
 from .params import Params
 
-__version__ = '0.4.0'
+__version__ = '0.4.1'
diff --git a/params/params.py b/params/params.py
@@ -72,6 +72,9 @@ def from_dict(cls, args, return_instance=True, return_unused=True):
 
         :param args: keyword dictionary with parameters
         :param return_instance: False to return a dictionary instead of a Params instance.
+               **N.B.** the `dict` returned by `MyParams.from_dict(return_instance=False))`
+               does not include the `MyParams` default params (unlike an instance
+               created with `return_instance=True`).
         :param return_unused: True to return the arguments not valid for the current class.
         :return: a tuple (params, other) of params and a dict of unused arguments,
                  where params is either a dict or a Params instance (where ``return_instance=True``).