Description of an argument

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: get_TEClassifiers_class_names(), get_called_args(), get_depr_obj_names(), get_magnitude_values(), get_param_def(), get_param_dict()