]> SALOME platform Git repositories - modules/shaper.git/blobdiff - src/PythonAPI/model/parameter/parameter.py
Salome HOME
Improve PythonAPI documentstion.
[modules/shaper.git] / src / PythonAPI / model / parameter / parameter.py
index 51c9024fd3707415119c035cdc0350cb6f786710..7dfe03c446d4b33f4ea94f4a73e4d8a8845e5342 100644 (file)
@@ -16,18 +16,17 @@ def addParameter(part, *args):
 
 
 class Parameter(Interface):
-    """Interface on a Parameter feature."""
+    """Interface class for Parameter feature.
 
-    def __init__(self, feature, *args):
-        """Initialize a Parameter feature with given parameters.
-
-        Expected arguments for all modes:
-        feature -- a Parameter feature
+    Parameter(feature) -> feature interface without initialization
+    Parameter(feature, variable, expression) ->
+        feature interface initialized from arguments:
+        - variable -- variable name
+        - expression -- Python expression
+    """
 
-        For initialization (expect 2 arguments):
-        name -- variable name
-        expression -- Python expression
-        """
+    def __init__(self, feature, *args):
+        """x.__init__(...) initializes x; see x.__class__.__doc__ for signature"""
         Interface.__init__(self, feature)
         assert(self._feature.getKind() == "Parameter")