xpath:add a docstring at the beginning

mokko · Jun 20, 2024 · 617dccf · 617dccf
1 parent fe3c2cc
commit 617dccf
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/zml2lido/xpathTool.py b/zml2lido/xpathTool.py
@@ -4,6 +4,12 @@
 # NSMAP is already present in linkChecker TODO
 NSMAP = {"l": "http://www.lido-schema.org"}
 
+"""
+Simply commandline tool that applies xpath to one or multiple files (using lxml internally)
+
+Please be aware that the -f file output does NOT aim to produce valid XML!
+"""
+
 
 def xpathTool(
     *, Input: str, xpath: str, file: bool = False, globbing: bool = False