Add missing docstrings.

domdfcoding · domdfcoding · commit aa7341fec230 · 2025-06-11T10:53:55.000+01:00
diff --git a/mh_utils/__init__.py b/mh_utils/__init__.py
@@ -82,6 +82,10 @@ def __deepcopy__(self, memodict={}):
 
 	@abstractmethod
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		return {}  # pragma: no cover (abc)
 
 	def __eq__(self, other) -> bool:
diff --git a/mh_utils/cef_parser/__init__.py b/mh_utils/cef_parser/__init__.py
@@ -142,6 +142,10 @@ def __init__(
 			raise TypeError(f"'matches' must be a dictionary, not {type(matches)}")
 
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		return dict(
 				name=self.name,
 				formula=self.formula,
@@ -317,6 +321,10 @@ def __init__(
 			]
 
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		data = {}
 		for key in self.__slots__:
 			data[key] = getattr(self, key)
@@ -611,6 +619,10 @@ def __init__(
 			self.spectra = []
 
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		return dict(
 				algo=self.algo,
 				location=self.location,
diff --git a/mh_utils/csv_parser/classes.py b/mh_utils/csv_parser/classes.py
@@ -204,6 +204,10 @@ def __repr__(self):
 		return f"Sample({self.sample_name})"
 
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		return AlphaDict(
 				sample_name=self.sample_name,
 				sample_type=self.sample_type,
@@ -425,6 +429,10 @@ def __repr__(self):
 		return f"Result({self.name}; {self.formula}; {self.rt}; {self.score})"
 
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		return AlphaDict(
 				cas=self._cas,
 				name=self.name,
diff --git a/mh_utils/worklist_parser/classes.py b/mh_utils/worklist_parser/classes.py
@@ -111,6 +111,10 @@ def from_xml(
 				)
 
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		data = {}
 		for key in self.__slots__:
 			if key == "id":
@@ -161,6 +165,10 @@ def __init__(
 	__slots__ = ["version", "user_columns", "jobs", "checksum", "locked_run_mode", "instrument_name", "params"]
 
 	def to_dict(self):
+		"""
+		Return a dictionary representation of the class.
+		"""
+
 		data = {}
 		for key in self.__slots__:
 			data[key] = getattr(self, key)
