From 16676e213e35e2dd7ceb8973b640ef7cf43b3ebc Mon Sep 17 00:00:00 2001
From: "Paul \"LeoNerd\" Evans" <leonerd@leonerd.org.uk>
Date: Mon, 8 Feb 2021 23:27:30 +0000
Subject: Add documentation comment to op.h to clarify that LOGOP's ->op_other
 is in execution order pointer, not a tree-structural one

---
 op.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'op.h')

diff --git a/op.h b/op.h
index 6d8729680b..c6de0d19fa 100644
--- a/op.h
+++ b/op.h
@@ -224,6 +224,12 @@ struct binop {
 struct logop {
     BASEOP
     OP *	op_first;
+
+    /* Note that op->op_other is the *next* op in execution order of the
+     * alternate branch, not the root of the subtree. I.e. imagine it being
+     * called ->op_otherfirst.
+     * To find the structural subtree root (what could be called
+     * ->op_otherroot), use OpSIBLING of ->op_first  */
     OP *	op_other;
 };
 
-- 
cgit v1.2.1