lua: fix return value documentation for record and code 2

[bplessis-swi]

Lua documentation state that the record field is only used when the code is equal to 1 but it's also used with 2 when we only change the record content if i am not mistaken

Summary by CodeRabbit

• Documentation
  • Clarified Lua callback docs: when returned codes indicate replacement (now applies to two specific codes) the original record is replaced; clarified timestamp handling and that a callback may emit multiple records if the returned value is an array.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update to Lua filter clarifies that the original record is replaced when callback return codes are 1 or 2, not just code 1 as previously stated.

Changes

Cohort / File(s)	Summary
Lua Filter Documentation pipeline/filters/lua.md	Clarified record replacement behavior in return values to indicate codes 1 and 2 result in record replacement, expanding the previously documented code 1 condition.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A doc update, clear and bright,
When code is one or two takes flight,
The record hops and changes hue,
I nibbled notes and made them true,
Joy in words — a tiny rabbit's delight! 🥕✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main documentation change: clarifying that the record field is used for both code 1 and code 2 in Lua callbacks.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[eschabell]

@bplessis-swi this is a good catch, thanks for the PR fix!