From 4f5c45d69c2963c1c2d1dde5e3970dac919a9d90 Mon Sep 17 00:00:00 2001
From: Florian Obersteiner <florian.obersteiner@kit.edu>
Date: Thu, 7 Apr 2022 10:52:26 +0200
Subject: [PATCH] comment on nHeader != nHeaderSuggested warning

---
 src/icartt/dataset.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/icartt/dataset.py b/src/icartt/dataset.py
index a193dae..811c500 100644
--- a/src/icartt/dataset.py
+++ b/src/icartt/dataset.py
@@ -712,6 +712,8 @@ class Dataset:
 
         self.nHeaderFile = f.line
 
+        # TODO this warning might be missleading since it assumes all normalComment keywords
+        #      had been defined - which is not guaranteed.
         if self.nHeader != nHeaderSuggested:
             warnings.warn(
                 f"Number of header lines suggested in line 1 ({int(nHeaderSuggested)}) do not match actual header lines read ({int(self.nHeader)})"
-- 
GitLab