README moves to markdown

[nepi.git] / src / nepi / execution / trace.py

diff --git a/src/nepi/execution/trace.py b/src/nepi/execution/trace.py
index 3b22eaf..c685527 100644 (file)
--- a/src/nepi/execution/trace.py
+++ b/src/nepi/execution/trace.py
@@ -3,9 +3,8 @@
 #    Copyright (C) 2013 INRIA
 #
 #    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation, either version 3 of the License, or
-#    (at your option) any later version.
+#    it under the terms of the GNU General Public License version 2 as
+#    published by the Free Software Foundation;
 #
 #    This program is distributed in the hope that it will be useful,
 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -18,30 +17,33 @@
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 
 class TraceAttr:
-    """ Class representing the different attributes 
-    that can characterized a trace.
-
+    """A Trace attribute defines information about a Trace that can
+    be queried
     """
-    ALL = 'all'
-    STREAM = 'stream'
-    PATH = 'path'
-    SIZE = 'size'
+    ALL = "all"
+    STREAM = "stream"
+    PATH = "path"
+    SIZE = "size"
 
 class Trace(object):
+    """ A Trace represents information about a Resource that can 
+    be collected 
     """
-    .. class:: Class Args :
-      
-        :param name: Name of the trace
-        :type name: str
-        :param help: Help about the trace
-        :type help: str
 
-    """
+    def __init__(self, name, help, enabled = False):
+        """
+        :param name: Name of the Trace
+        :type name: str
 
-    def __init__(self, name, help):
+        :param help: Description of the Trace
+        :type help: str
+        
+        :param enabled: Sets activation state of Trace
+        :type enabled: bool
+        """
         self._name = name
         self._help = help
-        self.enabled = False
+        self.enabled = enabled
 
     @property
     def name(self):