.alter function docstring command

Alters the DocString value of an existing function.

DocString is free text that you can attach to a table/function/column describing the entity. This string is presented in various UX settings next to the entity names.

Note

If the function doesn't exist, an error is returned. For more information on how to create a new function, see .create function.

Permissions

You must have at least Function Admin permissions to run this command. The principal that creates the function is automatically made a Function Admin.

Syntax

.alter function FunctionName docstring Documentation

Learn more about syntax conventions.

Parameters

Name	Type	Required	Description
FunctionName	string	✔️	The name of the function to alter.
Documentation	string	✔️	The new docstring value for the function.

Returns

Output parameter	Type	Description
Name	string	The name of the function
Parameters	string	The parameters required by the function
Body	string	(Zero or more) let statements followed by a valid CSL expression that is evaluated when the function is invoked
Folder	string	A folder used for UI functions categorization. This parameter doesn't change the way the function is invoked
DocString	string	A description of the function for UI purposes

Example

.alter function MyFunction1 docstring "Updated docstring"

Output

Name	Parameters	Body	Folder	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Updated docstring