get_param_doc_desc: Description of an argument

In aifeducation: Artificial Intelligence for Education

Description of an argument

Description

Function provides the description of an argument in markdown. Its aim is to be used for documenting the parameter of functions.

Usage

get_param_doc_desc(param_name)

Arguments

param_name

string Name of the parameter to request its definition.

Value

Returns a string which contains the description of the argument in markdown. The concrete format depends on the type of the argument.

See Also

Other Parameter Dictionary: BaseModelsIndex, DataSetsIndex, TokenizerIndex, doc_formula(), get_TEClassifiers_class_names(), get_called_args(), get_depr_obj_names(), get_magnitude_values(), get_param_def(), get_param_dict()

aifeducation documentation built on Nov. 19, 2025, 5:08 p.m.