@@ -123,35 +123,8 @@ def _render_method(doc: dict, method_rules: List[Rule], lines: List[str]) -> Non
123123 lines .append (f"**References:** { cites } \n " )
124124
125125
126- def _render_undocumented (by_method : Dict [str , List [Rule ]], lines : List [str ]) -> None :
127- """Render table of check methods that lack PHYSICS_DOCS entries."""
128- documented = set (PHYSICS_DOCS .keys ())
129- undocumented = sorted (m for m in by_method if m .startswith ("check_" ) and m not in documented )
130- if not undocumented :
131- return
132-
133- lines .append ("---\n " )
134- lines .append ("## Other Validation Checks\n " )
135- lines .append (
136- "The following checks do not yet have physics documentation. "
137- "See @ref contributing for how to add `PHYSICS_DOCS` entries.\n "
138- )
139- lines .append ("| Check | Parameters | Stage | Severity |" )
140- lines .append ("|-------|-----------|-------|----------|" )
141- for method in undocumented :
142- method_rules = by_method [method ]
143- stages = _collect_stages (method_rules )
144- title = method .replace ("check_" , "" ).replace ("_" , " " ).title ()
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- )
154- lines .append ("" )
126+ # Undocumented checks are omitted — they are discoverable via
127+ # @ref case_constraints "Case Creator Guide".
155128
156129
157130def render (rules : List [Rule ]) -> str :
@@ -191,8 +164,6 @@ def render(rules: List[Rule]) -> str:
191164 for method in methods :
192165 _render_method (PHYSICS_DOCS [method ], by_method .get (method , []), lines )
193166
194- _render_undocumented (by_method , lines )
195-
196167 return "\n " .join (lines )
197168
198169
0 commit comments