Description Function

description(parameter) returns the description text of the definition parameter, using the current language.

parameter can be a built-in or user-defined variable, function, or unit.

Syntax¶

If parameter is a built-in function, constant, or unit, description() returns the built-in description.

built-in functions, constants and units

If parameter is a user-defined function, variable, or unit, description() returns the user-defined description.

user-defined variables and functions

If the user-defined description has multiple lines, description() returns the description as a single-line string.

multi-line description returned as a single line

If the user-defined description is not set, description() returns an empty string or a zero value.

description() with no user-defined description

For more on documenting your worksheet with descriptions, see Descriptions.