feat: include comment, document logging methods

lucas-nelson-uiuc · lucas-nelson-uiuc · commit c618e127eb92 · 2024-12-31T14:55:54.000-06:00
diff --git a/src/tidy_tools/dataframe/dataframe.py b/src/tidy_tools/dataframe/dataframe.py
@@ -118,6 +118,16 @@ def wrapper(self, *args, **kwargs):
 
         return decorator
 
+    def comment(self, message: str) -> None:  # numpydoc ignore=PR01,RT01
+        """Log message to console to persist comments in logs."""
+        self._log(operation="comment", message=message)
+        return self
+
+    def document(self, message: str) -> None:  # numpydoc ignore=PR01,RT01
+        """Log message to console for documentation purposes."""
+        self._log(operation="document", message=message)
+        return self
+
     @classmethod
     def load(
         cls,
