From 288392f3a5236752a68e867bfe0b903bb9b23a60 Mon Sep 17 00:00:00 2001 From: Andreas Motl Date: Mon, 22 May 2023 18:49:25 +0200 Subject: [PATCH] Fix documentation about wrong return value for `filter` mechanism --- docs/configure/transformation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configure/transformation.md b/docs/configure/transformation.md index 6a148d3c..be6bb663 100644 --- a/docs/configure/transformation.md +++ b/docs/configure/transformation.md @@ -304,9 +304,9 @@ Within the mqttwarn processing pipeline, filtering functions will be invoked first, and will permit you to terminate processing early. A function called from the `filter` option in a [topic section](#topics) needs -to return `False` to stop the outbound notification. It obtains `topic`, +to return `True` to stop the outbound notification. It obtains `topic`, `payload`, `section`, and `srv` arguments, where `payload` is the MQTT message -payload as a [Python string](inv:python#tut-strings) decoded from UTF-8. +payload as a [Python string](inv:python#tut-strings) decoded from UTF-8. The function signature looks like this. ```python