From cd8f779c5159189137941942ce43cec8d0187966 Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Mon, 15 Jan 2024 22:38:01 +0100 Subject: [PATCH 1/3] doc: add types to template --- doc/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/README.md b/doc/README.md index 4ed9c47aee953..d99323ffe8f00 100644 --- a/doc/README.md +++ b/doc/README.md @@ -196,16 +196,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 From 6c7a483589dc0a05d9112b62d8db48cb31602a02 Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Mon, 15 Jan 2024 23:40:34 +0100 Subject: [PATCH 2/3] mention types explicitly --- doc/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index d99323ffe8f00..1ad0a08bf1bc4 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 From d6a12ff1f1fdc79e80941374cbb1a65da728f1ec Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Thu, 18 Jan 2024 12:50:25 +0100 Subject: [PATCH 3/3] use separator that allows for more items in the type declaration Co-authored-by: Daniel Sidhion --- doc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/README.md b/doc/README.md index 1ad0a08bf1bc4..c839da9e3e78c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -201,7 +201,7 @@ In that case, please open an issue about the particular documentation convention : The name of the resulting image. - `tag` (String, _optional_) + `tag` (String; _optional_) : Tag of the generated image.