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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
clarify wording on args@ default handling #8596
Conversation
Most importantly use shorter sentences and emphasize the key point that defaults aren't taken into account
No one sentence per line? |
> in | ||
> function {} | ||
> f {} | ||
> ```` | ||
> | ||
> will evaluate to an empty attribute set. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> will evaluate to an empty attribute set. | |
> and both expressions will evaluate to: | |
> | |
> ```nix | |
> [ 23 {} ] | |
> ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving this, but I would like to get at least in a follow-up PR the rewriting example. That I got the rewrite wrong the first time is all the more clear that this stuff is subtle and its useful to see the correct version!
Waiting for @roberth for whether I should add this here. |
It's very illustrative example I think. |
Motivation
I got slightly confused about what this was trying to tell me. I wouldn't have understood quickly if I didn't know it beforehand, and it's likely people would glance over it if it sounds hard to grasp.
Context
We recently discussed #1461 and checking the quality of documentation on that topic prompted an update.
Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.sh
src/*/tests
tests/nixos/*
Priorities
Add 馃憤 to pull requests you find important.