comment + clarify prop name

Author: zth

analysis/src/CompletionBackEnd.ml

@@ -1942,10 +1942,10 @@ Note: The `@react.component` decorator requires the react-jsx config to be set i
            in
            (dec2, doc))
     |> List.map mkDecorator
-  | Cargument {contextPath; argumentLabel; prefix} -> (
+  | Cargument {functionContextPath; argumentLabel; prefix} -> (
     let labels =
       match
-        contextPath
+        functionContextPath
         |> getCompletionsForContextPath ~full ~opens ~rawOpens ~allFiles ~pos
              ~env ~exact:true ~scope
         |> completionsGetTypeEnv

analysis/src/CompletionFrontEnd.ml

@@ -142,11 +142,19 @@ let findArgCompletables ~(args : arg list) ~endPos ~posBeforeCursor
         | Some prefix ->
           Some
             (Cargument
-               {contextPath; argumentLabel = Labelled labelled.name; prefix})
+               {
+                 functionContextPath = contextPath;
+                 argumentLabel = Labelled labelled.name;
+                 prefix;
+               })
       else if isExprHole exp then
         Some
           (Cargument
-             {contextPath; argumentLabel = Labelled labelled.name; prefix = ""})
+             {
+               functionContextPath = contextPath;
+               argumentLabel = Labelled labelled.name;
+               prefix = "";
+             })
       else loop rest
     | {label = None; exp} :: rest ->
       if Res_parsetree_viewer.isTemplateLiteral exp then None
@@ -158,7 +166,7 @@ let findArgCompletables ~(args : arg list) ~endPos ~posBeforeCursor
           Some
             (Cargument
                {
-                 contextPath;
+                 functionContextPath = contextPath;
                  argumentLabel =
                    Unlabelled {argumentPosition = !unlabelledCount};
                  prefix;
@@ -167,7 +175,7 @@ let findArgCompletables ~(args : arg list) ~endPos ~posBeforeCursor
         Some
           (Cargument
              {
-               contextPath;
+               functionContextPath = contextPath;
                argumentLabel = Unlabelled {argumentPosition = !unlabelledCount};
                prefix = "";
              })

analysis/src/SharedTypes.ml

@@ -531,10 +531,11 @@ module Completable = struct
     | Cjsx of string list * string * string list
         (** E.g. (["M", "Comp"], "id", ["id1", "id2"]) for <M.Comp id1=... id2=... ... id *)
     | Cargument of {
-        contextPath: contextPath;
+        functionContextPath: contextPath;
         argumentLabel: argumentLabel;
         prefix: string;
       }
+        (** e.g. someFunction(~someBoolArg=<com>), complete for the value of `someBoolArg` (true or false). *)
 
   (** An extracted type from a type expr *)
   type extractedType =
@@ -585,8 +586,8 @@ module Completable = struct
     | Cnone -> "Cnone"
     | Cjsx (sl1, s, sl2) ->
       "Cjsx(" ^ (sl1 |> list) ^ ", " ^ str s ^ ", " ^ (sl2 |> list) ^ ")"
-    | Cargument {contextPath; argumentLabel; prefix} ->
-      contextPathToString contextPath
+    | Cargument {functionContextPath; argumentLabel; prefix} ->
+      contextPathToString functionContextPath
       ^ "("
       ^ (match argumentLabel with
         | Unlabelled {argumentPosition} -> "$" ^ string_of_int argumentPosition