tinymist_query::docs

Type Alias UntypedSignatureDocs

Source 
pub type UntypedSignatureDocs = SignatureDocsT<()>;
Expand description

Documentation about a signature.

Aliased Type§

struct UntypedSignatureDocs {
    pub docs: EcoString,
    pub pos: Vec<ParamDocsT<()>>,
    pub named: BTreeMap<Interned<str>, ParamDocsT<()>>,
    pub rest: Option<ParamDocsT<()>>,
    pub ret_ty: (),
    pub hover_docs: OnceLock<EcoString>,
}

Fields§

§docs: EcoString

Documentation for the function.

§pos: Vec<ParamDocsT<()>>

The positional parameters.

§named: BTreeMap<Interned<str>, ParamDocsT<()>>

The named parameters.

§rest: Option<ParamDocsT<()>>

The rest parameter.

§ret_ty: ()

The return type.

§hover_docs: OnceLock<EcoString>

The full documentation for the signature.