From 41720972cb6c2b65b3b598811d16d19054b201eb Mon Sep 17 00:00:00 2001
From: Stefan Reck <stefan.reck@fau.de>
Date: Thu, 23 Jun 2022 13:06:06 +0200
Subject: [PATCH] add docstring

---
 src/km3io/tools.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/km3io/tools.py b/src/km3io/tools.py
index 377b611..1c92e47 100644
--- a/src/km3io/tools.py
+++ b/src/km3io/tools.py
@@ -540,6 +540,15 @@ def is_3dmuon(trigger_mask):
 
 
 def get_w2defs_idx(f):
+    """
+    Get the correct w2list_idx for the given file, or None if there is none.
+
+    Parameters
+    ----------
+    f : km3io.OfflineReader
+        The file.
+
+    """
     w2s_idx = {
         "genhen": km3io.definitions.w2list_genhen_idx,
         "gseagen": km3io.definitions.w2list_gseagen_idx,
-- 
GitLab