Příkaz .alter function docstring

DocString Změní hodnotu existující funkce.

DocString je volný text, který můžete připojit k tabulce, funkci nebo sloupci popisující entitu. Tento řetězec se zobrazuje v různých nastaveních uživatelského prostředí vedle názvů entit.

Poznámka

Pokud funkce neexistuje, vrátí se chyba. Další informace o tom, jak vytvořit novou funkci, najdete v tématu .create function.

Oprávnění

Ke spuštění tohoto příkazu musíte mít alespoň oprávnění Správa funkce. Objekt zabezpečení, který funkci vytvoří, se automaticky vytvoří jako Správa funkce.

Syntax

.alterfunctionNázevdocstring funkceDokumentace

Přečtěte si další informace o konvencích syntaxe.

Parametry

Název	Typ	Vyžadováno	Popis
Název funkce	string	✔️	Název funkce, která se má změnit.
Dokumentace	string	✔️	Nová hodnota docstringu pro funkci

Návraty

Výstupní parametr	Typ	Popis
Název	string	Název funkce
Parametry	string	Parametry vyžadované funkcí
Text	string	(Nula nebo více) let příkazy následované platným výrazem CSL, který se vyhodnotí při vyvolání funkce
Složka	string	Složka používaná ke kategorizaci funkcí uživatelského rozhraní. Tento parametr nemění způsob, jakým se funkce vyvolává.
DocString	string	Popis funkce pro účely uživatelského rozhraní

Příklad

.alter function MyFunction1 docstring "Updated docstring"

Výstup

Name	Parametry	Text	Složka	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Aktualizace docstringu