diff options
| author | Silvan Mosberger <silvan.mosberger@tweag.io> | 2023-08-08 00:10:32 +0200 |
|---|---|---|
| committer | Silvan Mosberger <silvan.mosberger@tweag.io> | 2023-08-08 00:10:32 +0200 |
| commit | e3ff8dbedaa0a0ee62b98b076531dbc62da50785 (patch) | |
| tree | 7a06ae76a6fe8b8974233f4edf58ac820e3d48d9 | |
| parent | lib.path: Indent comments the same (diff) | |
| download | nixpkgs-e3ff8dbedaa0a0ee62b98b076531dbc62da50785.tar.gz | |
lib.path: Add argument docs when missing
| -rw-r--r-- | lib/path/default.nix | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/path/default.nix b/lib/path/default.nix index 5b2f28e90dff..1a55a2a7be8d 100644 --- a/lib/path/default.nix +++ b/lib/path/default.nix @@ -307,7 +307,9 @@ in /* No rec! Add dependencies on this file at the top. */ { splitRoot "/foo/bar" => <error> */ - splitRoot = path: + splitRoot = + # The path to split the root off of + path: assert assertMsg (isPath path) "lib.path.splitRoot: Argument is of type ${typeOf path}, but a path was expected"; @@ -466,6 +468,7 @@ in /* No rec! Add dependencies on this file at the top. */ { => <error> */ subpath.components = + # The subpath string to split into components subpath: assert assertMsg (isValid subpath) '' lib.path.subpath.components: Argument is not a valid subpath string: |