Comando docstring della funzione .alter

Modifica il DocString valore di una funzione esistente.

DocString è testo libero che è possibile collegare a una tabella/funzione/colonna che descrive l'entità. Questa stringa viene presentata in varie impostazioni dell'esperienza utente accanto ai nomi delle entità.

Nota

Se la funzione non esiste, viene restituito un errore. Per altre informazioni su come creare una nuova funzione, vedere .create function.

Autorizzazioni

Per eseguire questo comando è necessario disporre almeno delle autorizzazioni di Amministrazione funzione. L'entità che crea la funzione viene creata automaticamente una funzione Amministrazione.

Sintassi

.alterfunctionFunctionnamedocstringDocumentazione

Altre informazioni sulle convenzioni di sintassi.

Parametri

Nome	Tipo	Obbligatoria	Descrizione
Functionname	string	✔️	Nome della funzione da modificare.
Documentazione	string	✔️	Nuovo valore docstring per la funzione.

Restituisce

Parametro di output	Tipo	Descrizione
Nome	string	Nome della funzione
Parametri	string	Parametri richiesti dalla funzione
Corpo	string	(Zero o più) let istruzioni seguite da un'espressione CSL valida che viene valutata quando viene richiamata la funzione
Cartella	string	Cartella usata per la categorizzazione delle funzioni dell'interfaccia utente. Questo parametro non modifica il modo in cui viene richiamata la funzione
DocString	string	Descrizione della funzione per scopi dell'interfaccia utente

Esempio

.alter function MyFunction1 docstring "Updated docstring"

Output

Nome	Parametri	Corpo	Cartella	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Docstring aggiornato