From 5efc62af09ab57d306fe9a87a65a4ff4a3d7d4fb Mon Sep 17 00:00:00 2001 From: gwen Date: Thu, 29 Aug 2013 09:32:32 +0200 Subject: [PATCH] docstring setpermissive --- tiramisu/setting.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tiramisu/setting.py b/tiramisu/setting.py index f8c1d37..879656c 100644 --- a/tiramisu/setting.py +++ b/tiramisu/setting.py @@ -400,6 +400,15 @@ class Settings(object): str(props)), props) def setpermissive(self, permissive, opt=None, path=None): + """ + enables us to put the permissives in the storage + + :param path: the option's path + :param type: str + :param opt: if an option object is set, the path is extracted. + it is better (faster) to set the path parameter + instead of passing a :class:`tiramisu.option.Option()` object. + """ if opt is not None and path is None: path = self._get_opt_path(opt) if not isinstance(permissive, tuple):