Module Merlin_sherlodoc.QuerySource

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

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

Describes a search on an identifier and a type.

Sourceval from_string : string -> t

Converts a string into a search query.

Sourceval to_string : t -> string

Inspect a query (mostly for debugging purpose).

Sourceval equal : t -> t -> bool

Equality between queries.

Sourceval 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).