mirror of
https://github.com/NotAShelf/nvf.git
synced 2026-06-23 04:53:27 +00:00
lib: format nixdoc values
Some checks are pending
Set up binary cache / cachix (default) (push) Waiting to run
Set up binary cache / cachix (maximal) (push) Waiting to run
Set up binary cache / cachix (nix) (push) Waiting to run
Treewide Checks / Validate flake (push) Waiting to run
Treewide Checks / Check formatting (push) Waiting to run
Treewide Checks / Check source tree for typos (push) Waiting to run
Treewide Checks / Validate documentation builds (push) Waiting to run
Treewide Checks / Validate documentation builds-1 (push) Waiting to run
Treewide Checks / Validate documentation builds-2 (push) Waiting to run
Treewide Checks / Validate documentation builds-3 (push) Waiting to run
Treewide Checks / Validate hyperlinks in documentation sources (push) Waiting to run
Treewide Checks / Validate Editorconfig conformance (push) Waiting to run
Build and deploy documentation / Check latest commit (push) Waiting to run
Build and deploy documentation / publish (push) Blocked by required conditions
Some checks are pending
Set up binary cache / cachix (default) (push) Waiting to run
Set up binary cache / cachix (maximal) (push) Waiting to run
Set up binary cache / cachix (nix) (push) Waiting to run
Treewide Checks / Validate flake (push) Waiting to run
Treewide Checks / Check formatting (push) Waiting to run
Treewide Checks / Check source tree for typos (push) Waiting to run
Treewide Checks / Validate documentation builds (push) Waiting to run
Treewide Checks / Validate documentation builds-1 (push) Waiting to run
Treewide Checks / Validate documentation builds-2 (push) Waiting to run
Treewide Checks / Validate documentation builds-3 (push) Waiting to run
Treewide Checks / Validate hyperlinks in documentation sources (push) Waiting to run
Treewide Checks / Validate Editorconfig conformance (push) Waiting to run
Build and deploy documentation / Check latest commit (push) Waiting to run
Build and deploy documentation / publish (push) Blocked by required conditions
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: Ia6dcbf5c44ff6d29e5760111179341226a6a6964
This commit is contained in:
parent
733c182e17
commit
56e20dd9c8
7 changed files with 322 additions and 322 deletions
106
lib/dag.nix
106
lib/dag.nix
|
|
@ -101,96 +101,96 @@ in {
|
|||
map = f: mapAttrs (n: v: v // {data = f n v.data;});
|
||||
|
||||
/**
|
||||
Create a DAG entry with explicit before and after dependency lists.
|
||||
Create a DAG entry with explicit before and after dependency lists.
|
||||
|
||||
# Type
|
||||
# Type
|
||||
|
||||
```
|
||||
entryBetween :: [String] -> [String] -> a -> DagEntry a
|
||||
```
|
||||
```
|
||||
entryBetween :: [String] -> [String] -> a -> DagEntry a
|
||||
```
|
||||
|
||||
# Arguments
|
||||
# Arguments
|
||||
|
||||
- `before`: List of entry names this entry must come before.
|
||||
- `after`: List of entry names this entry must come after.
|
||||
- `data`: Payload for this DAG entry.
|
||||
- `before`: List of entry names this entry must come before.
|
||||
- `after`: List of entry names this entry must come after.
|
||||
- `data`: Payload for this DAG entry.
|
||||
|
||||
# Example
|
||||
# Example
|
||||
|
||||
```nix
|
||||
entryBetween [ "c" ] [ "a" ] "payload"
|
||||
=> { data = "payload"; before = [ "c" ]; after = [ "a" ]; }
|
||||
```
|
||||
```nix
|
||||
entryBetween [ "c" ] [ "a" ] "payload"
|
||||
=> { data = "payload"; before = [ "c" ]; after = [ "a" ]; }
|
||||
```
|
||||
*/
|
||||
entryBetween = before: after: data: {inherit data before after;};
|
||||
|
||||
/**
|
||||
Create a DAG entry with no ordering constraints.
|
||||
Create a DAG entry with no ordering constraints.
|
||||
|
||||
The entry may be placed anywhere in the topological sort result.
|
||||
The entry may be placed anywhere in the topological sort result.
|
||||
|
||||
# Type
|
||||
# Type
|
||||
|
||||
```
|
||||
entryAnywhere :: a -> DagEntry a
|
||||
```
|
||||
```
|
||||
entryAnywhere :: a -> DagEntry a
|
||||
```
|
||||
|
||||
# Arguments
|
||||
# Arguments
|
||||
|
||||
- `data`: Payload for this DAG entry.
|
||||
- `data`: Payload for this DAG entry.
|
||||
|
||||
# Example
|
||||
# Example
|
||||
|
||||
```nix
|
||||
entryAnywhere "lua code here"
|
||||
=> { data = "lua code here"; before = []; after = []; }
|
||||
```
|
||||
```nix
|
||||
entryAnywhere "lua code here"
|
||||
=> { data = "lua code here"; before = []; after = []; }
|
||||
```
|
||||
*/
|
||||
entryAnywhere = entryBetween [] [];
|
||||
|
||||
/**
|
||||
Create a DAG entry that must come after the listed entries.
|
||||
Create a DAG entry that must come after the listed entries.
|
||||
|
||||
# Type
|
||||
# Type
|
||||
|
||||
```
|
||||
entryAfter :: [String] -> a -> DagEntry a
|
||||
```
|
||||
```
|
||||
entryAfter :: [String] -> a -> DagEntry a
|
||||
```
|
||||
|
||||
# Arguments
|
||||
# Arguments
|
||||
|
||||
- `after`: List of entry names this entry must follow.
|
||||
- `data`: Payload for this DAG entry.
|
||||
- `after`: List of entry names this entry must follow.
|
||||
- `data`: Payload for this DAG entry.
|
||||
|
||||
# Example
|
||||
# Example
|
||||
|
||||
```nix
|
||||
entryAfter [ "init" ] "setup code"
|
||||
=> { data = "setup code"; before = []; after = [ "init" ]; }
|
||||
```
|
||||
```nix
|
||||
entryAfter [ "init" ] "setup code"
|
||||
=> { data = "setup code"; before = []; after = [ "init" ]; }
|
||||
```
|
||||
*/
|
||||
entryAfter = entryBetween [];
|
||||
|
||||
/**
|
||||
Create a DAG entry that must come before the listed entries.
|
||||
Create a DAG entry that must come before the listed entries.
|
||||
|
||||
# Type
|
||||
# Type
|
||||
|
||||
```
|
||||
entryBefore :: [String] -> a -> DagEntry a
|
||||
```
|
||||
```
|
||||
entryBefore :: [String] -> a -> DagEntry a
|
||||
```
|
||||
|
||||
# Arguments
|
||||
# Arguments
|
||||
|
||||
- `before`: List of entry names this entry must precede.
|
||||
- `data`: Payload for this DAG entry.
|
||||
- `before`: List of entry names this entry must precede.
|
||||
- `data`: Payload for this DAG entry.
|
||||
|
||||
# Example
|
||||
# Example
|
||||
|
||||
```nix
|
||||
entryBefore [ "teardown" ] "cleanup code"
|
||||
=> { data = "cleanup code"; before = [ "teardown" ]; after = []; }
|
||||
```
|
||||
```nix
|
||||
entryBefore [ "teardown" ] "cleanup code"
|
||||
=> { data = "cleanup code"; before = [ "teardown" ]; after = []; }
|
||||
```
|
||||
*/
|
||||
entryBefore = before: entryBetween before [];
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue