-Added workflow note to warningfilter.py

1 files changed, 17 insertions, 9 deletions

diff --git a/contrib/warningfilter.py b/contrib/warningfilter.py
index 7b28c81dc..dce8997ce 100755
--- a/contrib/warningfilter.py
+++ b/contrib/warningfilter.py
@@ -3,6 +3,10 @@
 Filters and processes warnings generated by Doxygen, which are
 annoyingly inconsistent and verbose, to allow for easier reading.
 
+(Neo)vim commands to go to the file in a report:
+    :exe "let linenumber =" split(getline("."))[1]
+    :exe "edit" fnameescape(split(getline("."))[0]) "|" linenumber
+
 @author: willow <willow@howhill.com>
 """
 
@@ -65,7 +69,8 @@ parser_choices = set(matches.keys()) - {"blank",
 
 parser = ap.ArgumentParser()
 parser.add_argument("filename")
-parser.add_argument("keys", choices=parser_choices, nargs="*")
+parser.add_argument("--summary", "-s", action="store_true")
+parser.add_argument("--key", "-k", choices=parser_choices, action="append", dest="keys")
 args = parser.parse_args()
 
 sorted_lines = {k:[] for k in matches.keys()}
@@ -98,12 +103,15 @@ del processed_lines["undocumented param (name)"]
 
 # Preparing count dictionary and summarising the results
 counts = {k: len(v) for k, v in processed_lines.items()}
-for k, v in counts.items():
-    print(k+":", v)
-print("")
-
-for key in args.keys:
-    print(f"{key}: {counts[key]}")
-    for line in processed_lines[key]:
-        print(line)
+if args.summary:
+    for k, v in counts.items():
+        print(k+":", v)
+    print("")
+
+if args.keys is not None:
+    for key in args.keys:
+        print(f"{key}: {counts[key]}")
+        for line in processed_lines[key]:
+            print(line)
+        print("")