Module Merlin_sherlodoc.Query

Prepares a query based on a string of characters. A query acts on the identifier of a function and its type..

type t = {
  1. words : string list;
  2. type_expr : Type_expr.t option;
}

Describes a search on an identifier and a type.

val from_string : string -> t

Converts a string into a search query.

val to_string : t -> string

Inspect a query (mostly for debugging purpose).

val equal : t -> t -> bool

Equality between queries.

val distance_for : t -> path:string -> Type_expr.t -> int

distance_for query ~path typexpr returns a score for a query observing a given value, (a path and a type_expr).