Clarify documentation of polarity search

voodoos · Oct 24, 2024 · e79cce6 · e79cce6
1 parent 396d818
commit e79cce6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -6,7 +6,7 @@ unreleased
       files (#1854)
     - Fix occurrences bug in which relative paths in index files are resolved against the
       PWD rather than the SOURCE_ROOT (#1855)
-    - Fix exception in polarity search (#???? fixes #1113)
+    - Fix exception in polarity search (#1858 fixes #1113)
 
 merlin 5.2.1
 ============

diff --git a/src/commands/new_commands.ml b/src/commands/new_commands.ml
@@ -569,7 +569,11 @@ let all_commands =
       ~spec:
         [ arg "-position" "<position> Position to complete"
             (marg_position (fun pos (query, _pos) -> (query, pos)));
-          arg "-query" "<string> Query of the form TODO"
+          arg "-query"
+            "<string> Query of the form every input parameters prefixed by `-` \
+             and output parameters prefixed by `+`. In example: -string \
+             +option will fetch function that takes string and returns an \
+             option. (You can't parametrize types in polarity queries)"
             (Marg.param "string" (fun query (_prefix, pos) -> (query, pos)))
         ]
       ~default:("", `None)