From 5a9ce6be54e76f3aca02ffe00c71d2404901c962 Mon Sep 17 00:00:00 2001
From: jalew188 <jalew188@gmail.com>
Date: Tue, 18 Jun 2024 13:10:50 +0200
Subject: [PATCH] #53 FIX add more docs in psm_match.py

---
 alpharaw/match/psm_match.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/alpharaw/match/psm_match.py b/alpharaw/match/psm_match.py
index e058f27..0f5572c 100644
--- 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
         -------