Vars: interface improve docs formatting

This commit is contained in:
Johannes Kirschbauer
2025-01-14 17:40:17 +01:00
parent 5a179f4b91
commit 16ccebc1fb
2 changed files with 15 additions and 10 deletions

View File

@@ -60,7 +60,10 @@ in
description = ''
A list of other generators that this generator depends on.
The output values of these generators will be available to the generator script as files.
For example, the file 'file1' of a dependency named 'dep1' will be available via $in/dep1/file1.
For example:
**A file `file1` of a generator named `dep1` will be available via `$in/dep1/file1`**
'';
type = listOf str;
default = [ ];
@@ -321,9 +324,11 @@ in
description = ''
The script to run to generate the files.
The script will be run with the following environment variables:
- $in: The directory containing the output values of all declared dependencies
- $out: The output directory to put the generated files
- $prompts: The directory containing the prompted values as files
- $in: The directory containing the output values of all declared dependencies
- $out: The output directory to put the generated files
- $prompts: The directory containing the prompted values as files
The script should produce the files specified in the 'files' attribute under $out.
'';
type = either str path;

View File

@@ -55,9 +55,9 @@ class Identity:
def node_id(self) -> str:
nid = self.public.split(":")[0]
assert (
len(nid) == 10
), f"node_id must be 10 characters long, got {len(nid)}: {nid}"
assert len(nid) == 10, (
f"node_id must be 10 characters long, got {len(nid)}: {nid}"
)
return nid
@@ -172,9 +172,9 @@ def create_identity() -> Identity:
def compute_zerotier_ip(network_id: str, identity: Identity) -> ipaddress.IPv6Address:
assert (
len(network_id) == 16
), f"network_id must be 16 characters long, got '{network_id}'"
assert len(network_id) == 16, (
f"network_id must be 16 characters long, got '{network_id}'"
)
nwid = int(network_id, 16)
node_id = int(identity.node_id(), 16)
addr_parts = bytearray(