.alter function docstring 命令

更改现有函数的 DocString 值。

DocString 是可以附加到描述实体的表/函数/列的自由文本。 此字符串显示在实体名称旁边的各种 UX 设置中。

注意

如果该函数不存在,则返回错误。 有关如何创建新函数的详细信息,请参阅 .create function

权限

你必须至少具有函数管理员权限才能运行此命令。 创建函数的主体会自动成为函数管理员。

语法

.alterfunctionFunctionNamedocstringDocumentation

详细了解语法约定

参数

客户 类型​​ 必需 说明
FunctionName string 要更改的函数的名称。
文档 string 函数的新 docstring 值。

返回

输出参数 类型 说明
Name string 函数的名称
参数 string 函数所需的参数
正文 string (零个或零个以上)let 语句,后跟在调用函数时计算的有效 CSL 表达式
Folder string 用于 UI 函数分类的文件夹。 此参数不会更改函数调用方式
DocString string 用于 UI 目的的函数的说明

示例

.alter function MyFunction1 docstring "Updated docstring"

输出

名称 parameters 正文 文件夹 DocString
MyFunction2 (myLimit: long) {StormEvents | take myLimit} MyFolder 已更新 docstring