Browse Source

Docstring

Roland Haroutiounian 8 years ago
parent
commit
1849ddd48e
3 changed files with 4 additions and 1 deletions
  1. 2
    1
      lodel/settings/settings.py
  2. 1
    0
      lodel/settings/utils.py
  3. 1
    0
      lodel/settings/validator.py

+ 2
- 1
lodel/settings/settings.py View File

@@ -118,7 +118,7 @@ class Settings(object, metaclass=MetaSettings):
118 118
     ##@brief Saves a new configuration for section confname
119 119
     #@param confname is the name of the modified section
120 120
     #@param confvalue is a dict with variables to save
121
-    #@param validators is a dict with adapted validator
121
+    #@param validator is a dict with adapted validator
122 122
     @classmethod
123 123
     def set(cls, confname, confvalue,validator):
124 124
         loader = SettingsLoader(cls.instance.__conf_dir)
@@ -277,6 +277,7 @@ class Settings(object, metaclass=MetaSettings):
277 277
     
278 278
     ##@brief Forge a named tuple given a conftree node
279 279
     # @param conftree dict : A conftree node
280
+    # @param name str
280 281
     # @return a named tuple with fieldnames corresponding to conftree keys
281 282
     def __tree2namedtuple(self, conftree, name):
282 283
         ResNamedTuple = namedtuple(name, conftree.keys())

+ 1
- 0
lodel/settings/utils.py View File

@@ -10,6 +10,7 @@ class SettingsError(Exception):
10 10
     ##@brief Instanciate a new SettingsError
11 11
     # @param msg str : Error message
12 12
     # @param key_id str : The key concerned by the error
13
+    # @param filename str
13 14
     def __init__(self, msg = "Unknown error", key_id = None, filename = None):
14 15
         self.__msg = msg
15 16
         self.__key_id = key_id

+ 1
- 0
lodel/settings/validator.py View File

@@ -53,6 +53,7 @@ class SettingValidator(object):
53 53
     ##@brief Register a new validator
54 54
     # @param name str : validator name
55 55
     # @param callback callable : the function that will validate a value
56
+    # @param description str
56 57
     @classmethod
57 58
     def register_validator(cls, name, callback, description=None):
58 59
         if name in cls._validators:

Loading…
Cancel
Save