diff options
| author | Valentin Gagarin <valentin.gagarin@tweag.io> | 2024-01-25 16:06:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-25 16:06:24 +0100 |
| commit | 848f518363131449752a53d191276f661e22b5ee (patch) | |
| tree | 3c9bf9e6b5f87d242d771535b620a04e27d6ebff /doc | |
| parent | 5604753fc0f039cc8310722e617cd6798d5a52bc (diff) | |
doc: add types to template (#281220)
* doc: add types to template * mention types explicitly * use separator that allows for more items in the type declaration Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com> --------- Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/README.md b/doc/README.md index 4ed9c47aee953..c839da9e3e78c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -188,7 +188,8 @@ In that case, please open an issue about the particular documentation convention } ``` -- Use [definition lists](#definition-lists) to document function arguments, and the attributes of such arguments. For example: +- Use [definition lists](#definition-lists) to document function arguments, and the attributes of such arguments as well as their [types](https://nixos.org/manual/nix/stable/language/values). + For example: ```markdown # pkgs.coolFunction @@ -196,16 +197,15 @@ In that case, please open an issue about the particular documentation convention Description of what `coolFunction` does. `coolFunction` expects a single argument which should be an attribute set, with the following possible attributes: - `name` + `name` (String) : The name of the resulting image. - `tag` _optional_ + `tag` (String; _optional_) : Tag of the generated image. - _Default value:_ the output path's hash. - + _Default:_ the output path's hash. ``` ## Getting help |