.alter function docstring-Befehl

Ändert den DocString Wert einer vorhandenen Funktion.

DocString ist Freitext, den Sie an eine Tabelle/Funktion/Spalte anfügen können, die die Entität beschreibt. Diese Zeichenfolge wird in verschiedenen UX-Einstellungen neben den Entitätsnamen angezeigt.

Hinweis

Wenn die Funktion nicht vorhanden ist, wird ein Fehler zurückgegeben. Weitere Informationen zum Erstellen einer neuen Funktion finden Sie unter .create function.

Berechtigungen

Zum Ausführen dieses Befehls benötigen Sie mindestens Funktionsberechtigungen Admin. Der Prinzipal, der die Funktion erstellt, wird automatisch zu einer Funktion Admin.

Syntax

.alterfunctionFunctionnamedocstringDokumentation

Erfahren Sie mehr über Syntaxkonventionen.

Parameter

Name	Typ	Erforderlich	BESCHREIBUNG
Functionname	string	✔️	Der Name der zu ändernden Funktion.
Dokumentation	string	✔️	Der neue docstring-Wert für die Funktion.

Gibt zurück

Ausgabeparameter	type	BESCHREIBUNG
Name	string	Der Name der Funktion.
Parameter	string	Die für die Funktion erforderlichen Parameter
Text	string	(Null oder mehr) let Anweisungen gefolgt von einem gültigen CSL-Ausdruck, der ausgewertet wird, wenn die Funktion aufgerufen wird
Ordner	string	Ein Ordner, der für die Kategorisierung von UI-Funktionen verwendet wird. Dieser Parameter ändert nicht die Art und Weise, wie die Funktion aufgerufen wird.
DocString	string	Eine Beschreibung der Funktion für Benutzeroberflächenzwecke

Beispiel

.alter function MyFunction1 docstring "Updated docstring"

Ausgabe

Name	Parameter	Text	Ordner	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Aktualisierte Docstring-Datei