You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
The C API docs tend to say how the user needs to properly dispose of the values returned. e.g. nix_c_context_create() says "Owned by caller. Free using nix_c_context_free()"
nix_state_create() has a similar property where it's owned by the caller and needs a nix_state_free() call, but this isn't documented.
Describe the solution you'd like
Document the usage of nix_state_create()/nix_state_free() in the same way as nix_c_context_create()/nix_c_context_free()
Describe alternatives you've considered
The documentation already has a link to the nix_state_free() function, which is sort of clear enough, but for instance it doesn't show up in the rust documentation when you generate c bindings. Regardless, the documentation should be consistent between different functions.
Is your feature request related to a problem? Please describe.
The C API docs tend to say how the user needs to properly dispose of the values returned. e.g.
nix_c_context_create()
says "Owned by caller. Free usingnix_c_context_free()
"nix_state_create()
has a similar property where it's owned by the caller and needs anix_state_free()
call, but this isn't documented.Describe the solution you'd like
Document the usage of
nix_state_create()
/nix_state_free()
in the same way asnix_c_context_create()
/nix_c_context_free()
Describe alternatives you've considered
The documentation already has a link to the
nix_state_free()
function, which is sort of clear enough, but for instance it doesn't show up in the rust documentation when you generate c bindings. Regardless, the documentation should be consistent between different functions.Priorities
Add 👍 to issues you find important.
The text was updated successfully, but these errors were encountered: