add method descriptions

Signed-off-by: Csaba Kiraly <csaba.kiraly@gmail.com>
2023-03-01 22:21:31 +01:00 · 2023-03-01 22:21:31 +01:00 · 68fdaf3572
parent e611b5143c
commit 68fdaf3572
1 changed files with 4 additions and 2 deletions
--- a/DAS/block.py
+++ b/DAS/block.py
@ -21,10 +21,12 @@ class Block:
        self.data |= merged.data

    def getSegment(self, rowID, columnID):
+        """Check whether a segment is included"""
        return self.data[rowID*self.blockSize + columnID]

-    def setSegment(self, rowID, columnID, v = 1):
-        self.data[rowID*self.blockSize + columnID] = v
+    def setSegment(self, rowID, columnID, value = 1):
+        """Set value for a segment (default 1)"""
+        self.data[rowID*self.blockSize + columnID] = value

    def getColumn(self, columnID):
        """It returns the block column corresponding to columnID."""