Skip to content

Commit 95310bb

Browse files
sbryngelsonclaude
andcommitted
Add parameter column to undocumented checks table in physics docs
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3253e35 commit 95310bb

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

toolchain/mfc/gen_physics_docs.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,21 @@ def _render_undocumented(by_method: Dict[str, List[Rule]], lines: List[str]) ->
136136
"The following checks do not yet have physics documentation. "
137137
"See @ref contributing for how to add `PHYSICS_DOCS` entries.\n"
138138
)
139-
lines.append("| Check | Stage | Severity |")
140-
lines.append("|-------|-------|----------|")
139+
lines.append("| Check | Parameters | Stage | Severity |")
140+
lines.append("|-------|-----------|-------|----------|")
141141
for method in undocumented:
142142
method_rules = by_method[method]
143143
stages = _collect_stages(method_rules)
144144
title = method.replace("check_", "").replace("_", " ").title()
145-
lines.append(f"| {title} | {_stages_str(stages)} | {_severity_badge(method_rules)} |")
145+
params: Set[str] = set()
146+
for r in method_rules:
147+
params.update(r.params)
148+
param_str = ", ".join(f"`{p}`" for p in sorted(params)[:6])
149+
if len(params) > 6:
150+
param_str += ", ..."
151+
lines.append(
152+
f"| {title} | {param_str} | {_stages_str(stages)} | {_severity_badge(method_rules)} |"
153+
)
146154
lines.append("")
147155

148156

0 commit comments

Comments
 (0)