auxolotl/lib
27
5
Fork 9
Code Issues 9 Pull requests 2 Projects Releases 3 Packages Wiki Activity Actions

docs: migrate lib.generators to doc-comments

Browse source
This commit is contained in:
KFears 2025-09-14 19:42:13 +04:00
parent 99b3d68da8
commit 9ba13a521e
Signed by: KFearsoff
SSH key fingerprint: SHA256:sn39ts1xvi/KGQNlqDyrj8nNlhp9ilndgIolXKnPraw
1 changed files with 18 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

24
src/generators/default.nix
View file

@ -1,7 +1,13 @@
lib: {
## Limit evaluation of a valud to a certain depth.
##
## @type { limit? :: Int | Null, throw? :: Bool } -> a -> a
/**
Limit evaluation of a value to a certain depth.
# Type
```
withRecursion :: { limit? :: Int | Null, throw? :: Bool } -> a -> a
```
*/
withRecursion =
{
limit ? null,
@ -39,9 +45,15 @@ lib: {
in
process 0;
## Create a pretty printer for Nix values.
##
## @type { indent? :: String, multiline? :: Bool, allowCustomPrettifiers? :: Bool } -> a -> string
/**
Create a pretty printer for Nix values.
# Type
```
pretty :: { indent? :: String, multiline? :: Bool, allowCustomPrettifiers? :: Bool } -> Any -> String
```
*/
pretty =
{
indent ? "",