Skip to content

Commit

Permalink
Fix documentation about wrong return value for filter mechanism
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed May 22, 2023
1 parent ef43029 commit 288392f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/configure/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 288392f

Please sign in to comment.