Skip to content

Commit 05e5bd2

Browse files
committed
Docs
1 parent 02360dd commit 05e5bd2

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

src/libexpr-c/nix_api_expr.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,11 @@ nix_err nix_gc_incref(nix_c_context * context, const void * object);
286286
/**
287287
* @brief Decrement the garbage collector reference counter for the given object
288288
*
289+
* We also provide typed `nix_*_decref` functions, which are
290+
* - safer to use
291+
* - easier to integrate when deriving bindings
292+
* - allow more flexibility
293+
*
289294
* @param[out] context Optional, stores error information
290295
* @param[in] object The object to stop referencing
291296
*/

src/libexpr/value-to-json.cc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
namespace nix {
1212
using json = nlohmann::json;
13+
// TODO: rename. It doesn't print.
1314
json printValueAsJSON(EvalState & state, bool strict,
1415
Value & v, const PosIdx pos, NixStringContext & context, bool copyToStore)
1516
{

src/libflake/include/nix/flake/flake.hh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ struct ConfigFile
6363
};
6464

6565
/**
66-
* The contents of a flake.nix file.
66+
* A flake in context
6767
*/
6868
struct Flake
6969
{

0 commit comments

Comments
 (0)