regcomp.c: Improve comment wording

khwilliamson · khwilliamson · commit 61fa371c266f · 2025-08-21T07:25:24.000-06:00
diff --git a/regcomp.c b/regcomp.c
@@ -4533,8 +4533,8 @@ S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp, U32 depth)
  *
  * Implements the concatenation operator.
  *
- * On success, returns the offset at which any next node should be placed into
- * the regex engine program being compiled.
+ * On success, creates a branch node, and returns the position any next node
+ * should be placed into the regex engine program being compiled.
  *
  * Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs
  * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to

Original file line number	Diff line number	Diff line change
`@@ -4533,8 +4533,8 @@ S_reg(pTHX_ RExC_state_t pRExC_state, I32 paren, I32 flagp, U32 depth)`
`4533`	`4533`	`*`
`4534`	`4534`	`* Implements the concatenation operator.`
`4535`	`4535`	`*`
`4536`		`- * On success, returns the offset at which any next node should be placed into`
`4537`		`- * the regex engine program being compiled.`
	`4536`	`+ * On success, creates a branch node, and returns the position any next node`
	`4537`	`+ * should be placed into the regex engine program being compiled.`
`4538`	`4538`	`*`
`4539`	`4539`	`* Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs`
`4540`	`4540`	`* to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to`