#53 FIX add more docs in psm_match.py

MannLabs · Jun 18, 2024 · 5a9ce6b · 5a9ce6b
1 parent d243b64
commit 5a9ce6b
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/alpharaw/match/psm_match.py b/alpharaw/match/psm_match.py
@@ -146,7 +146,10 @@ def _add_missing_columns_to_psm_df(
 
     def _prepare_matching_dfs(self) -> Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame]:
         """
-        Prepare dataframes to be matched.
+        Prepare empty `fragment_mz_df`, `matched_intensity_df`,
+        and `matched_mz_err_df` dataframes to extract peak matching information
+        for `self.psm_df`. These three dataframes will be only used internally
+        in :class:`PepSpecMatch` objects.
 
         Returns
         -------