Skip to content

doc: add types to template #281220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
infinisil merged 3 commits into from
Jan 25, 2024
Merged

doc: add types to template #281220

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd8f779
doc: add types to template
fricklerhandwerk Jan 15, 2024
6c7a483
mention types explicitly
fricklerhandwerk Jan 15, 2024
d6a12ff
use separator that allows for more items in the type declaration
fricklerhandwerk Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,24 +188,24 @@ 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

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
Expand Down