From dd785ae20c21d44c4ebf417d8858c6ff0e940ff8 Mon Sep 17 00:00:00 2001
From: jalew188 <jalew188@gmail.com>
Date: Tue, 18 Jun 2024 15:20:58 +0200
Subject: [PATCH] FIX docs with more details

---
 alpharaw/utils/ms_path_utils.py | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/alpharaw/utils/ms_path_utils.py b/alpharaw/utils/ms_path_utils.py
index 7036371..d07a3cd 100644
--- a/alpharaw/utils/ms_path_utils.py
+++ b/alpharaw/utils/ms_path_utils.py
@@ -22,12 +22,18 @@ def get_raw_name(ms_file: str) -> str:
     Parameters
     ----------
     ms_file : str
-        The file path of the RAW data.
+        The absolute or relative path of the RAW file.
 
     Returns
     -------
     str
         The `raw_name` without extension.
+
+    Examples
+    --------
+    >>> get_raw_name("/MS/files/your_raw_name.raw")
+    'your_raw_name'
+
     """
     raw_name = os.path.basename(ms_file)
     lower_name = raw_name.lower()