Skip to content

doc: add types to template#281220

Merged
infinisil merged 3 commits intoNixOS:masterfrom
fricklerhandwerk:doc-argument-types
Jan 25, 2024
Merged

doc: add types to template#281220
infinisil merged 3 commits intoNixOS:masterfrom
fricklerhandwerk:doc-argument-types

Conversation

@fricklerhandwerk
Copy link
Contributor

@DanielSidhion here's a proposal, following up on #281211 (comment)


Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added the 8.has: documentation This PR adds or changes documentation label Jan 15, 2024
Copy link
Member

@DanielSidhion DanielSidhion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it would be useful to mention the names from https://nixos.org/manual/nix/stable/language/values (or some other resource), just to try to get people use the same names, e.g. "Attribute set" instead of "Attrset" (or something else).

This is optional though, because imo it's more important to have some type even if not consistent throughout the docs (which we can be fixed later, especially because the definition list format is already well-defined).

@fricklerhandwerk
Copy link
Contributor Author

Good point, added a reference to types.

@DanielSidhion DanielSidhion added the 12.approvals: 1 This PR was reviewed and approved by one person. label Jan 15, 2024
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels Jan 16, 2024
Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>
@delroth delroth removed the 12.approvals: 1 This PR was reviewed and approved by one person. label Jan 18, 2024
@infinisil infinisil merged commit 848f518 into NixOS:master Jan 25, 2024
@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2024-01-25-documentation-team-meeting-notes-106/38792/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants