.alter function docstring komutu

DocString Mevcut bir işlevin değerini değiştirir.

DocString , varlığı açıklayan bir tabloya/işleve/sütuna ekleyebileceğiniz serbest metindir. Bu dize, varlık adlarının yanındaki çeşitli UX ayarlarında gösterilir.

Not

İşlev yoksa bir hata döndürülür. Yeni işlev oluşturma hakkında daha fazla bilgi için bkz .create function. .

İzinler

Bu komutu çalıştırmak için en az İşlev Yönetici izinlerine sahip olmanız gerekir. İşlevi oluşturan sorumlu otomatik olarak bir İşlev Yönetici yapılır.

Syntax

.alterfunctionfunctionnamedocstringBelge

Söz dizimi kuralları hakkında daha fazla bilgi edinin.

Parametreler

Ad	Tür	Gerekli	Açıklama
functionname	string	✔️	Değiştirecek işlevin adı.
Belgeler	string	✔️	İşlev için yeni docstring değeri.

Döndürülenler

Çıkış parametresi	Tür	Açıklama
Ad	string	İşlevin adı
Parametreler	string	İşlevin gerektirdiği parametreler
Gövde	string	(Sıfır veya daha fazla) let deyimleri ve ardından işlev çağrıldığında değerlendirilen geçerli bir CSL ifadesi
Klasör	string	UI işlevleri kategorilere ayırma için kullanılan bir klasör. Bu parametre işlevin çağrılma şeklini değiştirmez
DocString	string	Kullanıcı arabirimi amacıyla işlevin açıklaması

Örnek

.alter function MyFunction1 docstring "Updated docstring"

Çıkış

Name	Parametreler	Gövde	Klasör	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Docstring güncelleştirildi