Add some internal documentation for flake support objects. #4080
Conversation
src/libexpr/flake/flakeref.hh
Outdated
| @@ -12,10 +12,25 @@ class Store; | |||
|
|
|||
| typedef std::string FlakeId; | |||
|
|
|||
| // The FlakeRef represents a local nix store reference to a flake | |||
There was a problem hiding this comment.
The "local nix store reference" bit is confusing. Maybe something like "A flake reference specifies how to fetch a flake (e.g. from a Git repository). It is created from a URL-like syntax (e.g. 'github:NixOS/patchelf') or from an attrset representation (e.g. '{ type = "github"; owner = "NixOS"; repo = "patchelf"; }').".
There was a problem hiding this comment.
Thanks, that does sound clearer. I made a couple of additional adjustments to this description that occurred to me as I was working on it; let me know what you think of the updated version.
src/libexpr/flake/flake.hh
Outdated
| @@ -17,20 +17,41 @@ struct FlakeInput; | |||
|
|
|||
| typedef std::map<FlakeId, FlakeInput> FlakeInputs; | |||
|
|
|||
| // FlakeInput is the flake-level parsed form of the "input" entries in | |||
There was a problem hiding this comment.
Could you use /* ... */ style comments? We mostly use // for single-line comments.
There was a problem hiding this comment.
Sure. I made this in its own commit with no other wording changes (although some fmt wrapping updates occurred); all wording changes are in different commits to make it easier to see those changes.
|
Thanks for the suggestions, @edolstra . I've made all the updates and this is ready for reviewing again. |
|
@edolstra pinging you since it would great to get this merged before things diverged. |
Please feel free to update any parts that are not correct or poorly stated, but hopefully this will help for comprehension and maintenance of the flake support.