aboutsummaryrefslogtreecommitdiff
path: root/embassy-executor/gen_config.py
diff options
context:
space:
mode:
authorBarnaby Walters <[email protected]>2023-12-22 19:05:16 +0100
committerBarnaby Walters <[email protected]>2023-12-22 19:05:16 +0100
commit6bbc316312b2ba372ea05c52924d99bc4fb5382a (patch)
treef653e192f72b0762c9bd185a9f9ba0194bac3c88 /embassy-executor/gen_config.py
parent87c03037e320ce30c0cd34fe97e0365e1b11aa9a (diff)
[embassy-executor] improved documentation
* Feature auto-documentation * Task arena sizes in a <details> list * Non-documented comment explaining turbowakers with see-also link Further improvements: * Are the task-arena-size-* numbers sizes in bytes? or something else? * Task arena section could benefit from advice about how to choose a suitable size
Diffstat (limited to 'embassy-executor/gen_config.py')
-rw-r--r--embassy-executor/gen_config.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/embassy-executor/gen_config.py b/embassy-executor/gen_config.py
index e427d29f4..cf32bd530 100644
--- a/embassy-executor/gen_config.py
+++ b/embassy-executor/gen_config.py
@@ -45,6 +45,12 @@ things = ""
45for f in features: 45for f in features:
46 name = f["name"].replace("_", "-") 46 name = f["name"].replace("_", "-")
47 for val in f["vals"]: 47 for val in f["vals"]:
48 things += f"## {val}"
49 if val == f["default"]:
50 things += " (default)\n"
51 else:
52 things += "\n"
53
48 things += f"{name}-{val} = []" 54 things += f"{name}-{val} = []"
49 if val == f["default"]: 55 if val == f["default"]:
50 things += " # Default" 56 things += " # Default"