improve note in nix_value_force
documentation again
#10842
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
the documentation of
nix_value_force
contains a note that needs fixing.this sounds like "all functions that return a
Value
call [nix_value_force
] for you" on theValue
that they return. but this is wrong becausenix_init_apply
, for example, does not callnix_value_force
on its return value. indeed, it would be silly because no function could ever return a thunk.i believe the documentation is trying to say here that "all functions that return a
Value
call [nix_value_force
] for you" on their arguments.some
Value
returning functions do not even need to force their arguments because they return a thunk themselves anyway though. so i think the easiest and most accurate statement is as follows.This work is sponsored by Antithesis ✨
Context
i just edited the rest of this note in #10828 but overlooked the misleadingness i am trying to fix here now.
Priorities and Process
Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.