procedure_doc

Returns the doc string for a given procedure. An empty string is returned if the procedure has no doc string.

This function does not generate an event.

Function

procedure_doc(procedure);

Arguments

Argument Type Description
procedure str (required) Name of the procedure where to return the doc string for.

Return value

Returns the doc string for a given procedure.

Example

Create a new procedure add_one:

new_procedure('add_one', |x| {
    "Adds one to a given value";
    x + 1;
});

// Return the doc string for procedure `add_one`
procedure_doc('add_one');

Return value in JSON format

"Adds one to a given value"