aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-09-15 13:57:39 +0200
committerMichael Muré <batolettre@gmail.com>2018-09-15 13:57:39 +0200
commitbcf2b6dbe64c789f5519db1ff715e995c7c67fda (patch)
treeb2d1ea1f0815cbc795e52b1e5fcc4a7471d45be4
parent7bec0b1f134d213e7505fc2ac03ffea26f2193cc (diff)
downloadgit-bug-bcf2b6dbe64c789f5519db1ff715e995c7c67fda.tar.gz
input: better help text for the query language
-rw-r--r--input/input.go21
1 files changed, 21 insertions, 0 deletions
diff --git a/input/input.go b/input/input.go
index 16264efc..4da73fc5 100644
--- a/input/input.go
+++ b/input/input.go
@@ -153,6 +153,27 @@ const queryTemplate = `%s
# Please edit the bug query.
# Lines starting with '#' will be ignored, and an empty query aborts the operation.
+#
+# Example: status:open author:"rené descartes" sort:edit
+#
+# Valid filters are:
+#
+# - status:open, status:closed
+# - author:<query>
+# - label:<label>
+# - no:label
+#
+# Sorting
+#
+# - sort:id, sort:id-desc, sort:id-asc
+# - sort:creation, sort:creation-desc, sort:creation-asc
+# - sort:edit, sort:edit-desc, sort:edit-asc
+#
+# Notes
+#
+# - queries are case insensitive.
+# - you can combine as many qualifiers as you want.
+# - you can use double quotes for multi-word search terms (ex: author:"René Descartes")
`
// QueryEditorInput will open the default editor in the terminal with a