.alter függvény docstring parancsa

Módosítja egy DocString meglévő függvény értékét.

DocString az entitást leíró táblázathoz/függvényhez/oszlophoz csatolható szabad szöveg. Ez a sztring az entitásnevek mellett található különböző felhasználói felületi beállításokban jelenik meg.

Megjegyzés

Ha a függvény nem létezik, a rendszer hibát ad vissza. További információ az új függvények létrehozásáról: .create function.

Engedélyek

A parancs futtatásához legalább függvény-Rendszergazda engedéllyel kell rendelkeznie. A függvényt létrehozó egyszerű rendszer automatikusan függvényt Rendszergazda.

Syntax

.alterfunctionFunctionNamedocstringDokumentáció

További információ a szintaxis konvenciókról.

Paraméterek

Név	Típus	Kötelező	Leírás
FunctionName	string	✔️	A módosítandó függvény neve.
Dokumentáció	string	✔️	A függvény új docstring értéke.

Válaszok

Kimeneti paraméter	Típus	Leírás
Név	string	A függvény neve
Paraméterek	string	A függvény által igényelt paraméterek
Törzs	string	(Nulla vagy több) let utasítások, majd egy érvényes CSL-kifejezés, amely a függvény meghívásakor lesz kiértékelve
Mappa	string	A felhasználói felületi függvények kategorizálásához használt mappa. Ez a paraméter nem módosítja a függvény meghívásának módját
DocString	string	A függvény leírása felhasználói felületi célokra

Példa

.alter function MyFunction1 docstring "Updated docstring"

Kimenet

Name	Paraméterek	Törzs	Mappa	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Frissített dokumentumszkontring