add docstring

usc-isi-i2 · Dec 7, 2018 · ed0d429 · ed0d429
1 parent f6be3fe
commit ed0d429
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/rltk/record.py b/rltk/record.py
@@ -126,6 +126,14 @@ def get_property_names(cls: type):
 
 @remove_raw_object
 class AutoGeneratedRecord(Record):
+    """
+    Properties are auto generated based on the keys in `raw_object`.
+
+    `raw_object` has to contain `id` which used as id in record.
+
+    Args:
+        raw_object (object): Raw data which will be used to create properties.
+    """
 
     def __init__(self, raw_object):
         super().__init__(raw_object)