Aracılığıyla paylaş


.alter function docstring komutu

DocString Var olan 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ından İşlev Yöneticisi izinlerine sahip olmanız gerekir. İşlevi oluşturan sorumlu otomatik olarak bir İşlev Yöneticisi yapılır.

Sözdizimi

.alterfunction FunctionName docstring Belgeleri

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

Parametreler

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

Döndürülenler

Çıkış parametresi Type 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 KULLANıCı arabirimi 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"

Çıktı

Veri Akışı Adı Parametreler Gövde Klasör DocString
MyFunction2 (myLimit: long) {StormEvents | take myLimit} MyFolder Güncelleştirilmiş docstring