record: Docstrings and examples for features and evaluated

Author: mhash1m

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documentation on writing examples and running doctests
 - Doctestable Examples to high-level API.
 - Shouldi got an operation to run npm-audit on JavaScript code
+- Docstrings and doctestable examples for `record.py` (features and evaluated)
 ### Changed
 - Restructured contributing documentation
 - Use randomly generated data for scikit tests

dffml/record.py

@@ -182,6 +182,27 @@ def key(self) -> str:
     def evaluated(self, results: Dict[str, Any], overwrite=False):
         """
         Updates features with the result dict
+
+        Parameters
+        ----------
+        results : dict
+            The results that will be added to the features.
+        overwrite : boolean
+            If 'True', the function overwrites the current features with the results provided.
+            If 'Fasle', the function updates the current features with the results provided.
+
+        Examples
+        --------
+        >>> example = Record("example", data=dict(features=dict(dead="beef")))
+        >>> print(example.features())
+        {'dead': 'beef'}
+        >>> results = {"new": "feature"}
+        >>> example.evaluated({"feed": "face"})
+        >>> print(example.features())
+        {'dead': 'beef', 'feed': 'face'}
+        >>> example.evaluated(results, overwrite=True)
+        >>> print(example.features())
+        {'new': 'feature'}
         """
         if overwrite:
             self.data.features = results
@@ -193,6 +214,23 @@ def evaluated(self, results: Dict[str, Any], overwrite=False):
     def features(self, subset: List[str] = []) -> Dict[str, Any]:
         """
         Returns all features for the record or the subset specified.
+
+        Parameters
+        ----------
+        subset : list
+            The subset of features that will be returned.
+
+        Returns
+        -------
+        dict
+            features.
+
+        Examples
+        --------
+        >>> example = Record("example", data=dict(features=dict(dead="beef")))
+        >>>
+        >>> print(example.features(["dead"]))
+        {'dead': 'beef'}
         """
         if not subset:
             return self.data.features

docs/doctest_header.py

@@ -17,7 +17,7 @@
 os.chdir(DOCTEST_TEMPDIR)
 
 from dffml_model_scikit import *
-
+from dffml.record import RecordPrediction, RecordData, Record
 from dffml import *
 from dffml.base import *
 from dffml.df.base import *