Update parser.py documentation with a warning/clarification.

savon-noir · Jan 17, 2025 · 6c0ee1a · 6c0ee1a
1 parent ed0619e
commit 6c0ee1a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/libnmap/parser.py b/libnmap/parser.py
@@ -34,7 +34,9 @@ def parse(cls, nmap_data=None, data_type="XML", incomplete=False):
 
         :param incomplete: enable you to parse interrupted nmap scans \
         and/or incomplete nmap xml blocks by adding a </nmaprun> at \
-        the end of the scan.
+        the end of the scan. Be aware that this flag does not work for \
+        already valid XML files, because adding an XML tag will \
+        invalidate the XML.
         :type incomplete: boolean
 
         As of today, only XML parsing is supported.