clarify not on nix_value_force (#10842)

* clarify not on `nix_value_force`

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
This commit is contained in:
Philipp 2024-06-04 09:41:04 +02:00 committed by GitHub
parent bf72b78ef2
commit 214051ba79
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -129,8 +129,7 @@ nix_err nix_value_call_multi(
*
* This function converts these Values into their final type.
*
* @note You don't need this function for basic API usage very often, since all functions that return a `Value` call it
* for you. This function is mainly needed before calling @ref getters.
* @note This function is mainly needed before calling @ref getters, but not for API calls that return a `Value`.
*
* @param[out] context Optional, stores error information
* @param[in] state The state of the evaluation.