Spec-Zone.ru › Nushell

attr example для core

Атрибут для добавления примеров к пользовательским командам.

Сигнатура

> attr example {flags} (description) (example)

Флаги

  • --result {any}: Ожидаемый результат примера.

Параметры

  • description: Описание примера.
  • example: Фрагмент кода примера.

Типы входных и выходных данных:

входные данные выходные данные
ничего record<description: string, example: string>

Примеры

Добавление примеров к пользовательской команде.

> # Double numbers
    @example "double an int" { 2 | double } --result 4
    @example "double a float" { 0.25 | double } --result 0.5
    def double []: [number -> number] { $in * 2 }

Copyright © 2019–2026 The Nushell Project DevelopersLicensed under the MIT License.
https://www.nushell.sh/commands/docs/attr_example.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API