Doc: mention elif, nested conditionals#12869
Conversation
bneradt
left a comment
There was a problem hiding this comment.
Looks good. A few minor comments.
69202de to
2b0067b
Compare
There was a problem hiding this comment.
Pull request overview
Updates the HRW4U admin-guide documentation to cover recently added elif support and explicitly document nested conditional usage/limits.
Changes:
- Document
elifin the HRW4U conditional syntax description and comparison table. - Add a nested-conditional example and state the maximum nesting depth (10).
- Update the introductory example to include an
elifbranch.
| The basic structure is a `section` name defining the part of the transaction to run in | ||
| followed by conditionals and operators. It uses `if () {} else {}` conditional syntax | ||
| followed by conditionals and operators. It uses `if () {} elif () {} else {}` conditional syntax | ||
| with `&& , || and ==`, with conditions and operators generally following function() or |
There was a problem hiding this comment.
The inline syntax example uses if () {} / elif () {} with empty conditions, which reads like valid code but isn’t valid HRW4U syntax. Consider using an ellipsis placeholder (e.g., if (...) { ... } elif (...) { ... } else { ... }) to avoid implying empty conditions are allowed.
| Else branches `else` with indented ops `elif ... { ... }` and `else { ... }` with full blocks | ||
| Debugging Manual with logs Built-in debug tracing (`--debug`) |
There was a problem hiding this comment.
This simple-table row likely exceeds the column width for the HRW4U column, which can break reStructuredText table parsing/rendering. Please wrap the HRW4U cell onto an indented continuation line (aligned with the start of the HRW4U column) or widen the table separator line so the column is wide enough.
Missed some documentation when adding elif and nested conditionals.
2b0067b to
28a398b
Compare
Missed some documentation when adding elif and nested conditionals.