From ae625486617749f7fa90c1af6f8abfa00e74410c Mon Sep 17 00:00:00 2001
From: jkuhl-uni <j_kuhl19@uni-muenster.de>
Date: Tue, 20 Dec 2022 13:44:07 +0100
Subject: [PATCH] Add a better docstring to read_ms5_xsf method

---
 pyerrors/input/openQCD.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/pyerrors/input/openQCD.py b/pyerrors/input/openQCD.py
index e0902569..eb9fb99e 100644
--- a/pyerrors/input/openQCD.py
+++ b/pyerrors/input/openQCD.py
@@ -988,7 +988,25 @@ def read_qtop_sector(path, prefix, c, target=0, **kwargs):
 
 
 def read_ms5_xsf(path, prefix, qc, corr):
+    """
+    Read and process data from files with a specific prefix and containing the given quark combination in the file name.
 
+    Parameters
+    ----------
+    path : str
+        The path to the directory containing the data files.
+    prefix : str
+        The prefix of the data files to be processed.
+    qc : str
+        The quark combination to be used to filter the data files.
+    corr : str
+        The correlator to be extracted from the data files.
+
+    Returns
+    -------
+    list of list of float
+        A list of lists containing the real and imaginary parts of the specified correlator for each configuration.
+    """
     found = []
     files = []
     for (dirpath, dirnames, filenames) in os.walk(path + "/"):