Skip to content

Commit

Permalink
Add note regarding writable PVs and msg_apply_changes
Browse files Browse the repository at this point in the history
  • Loading branch information
xkaraman committed Aug 19, 2024
1 parent 51753bc commit 7d6d034
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/cookbooks/devel/pseudovariables.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Pseudo-Variables are implemented by various modules, most of them are
provided by **pv** (if there is no special reference to a module, expect
that the pseudo-variable is provided by **pv** module).

**_NOTE: When using pseudo-variables in the configuration file that are writable, to change part of the message, applying them all at once can result in unintended side-effects. To ensure that the changes are applied to the message as intended, it is recommended to use the `msg_apply_changes()` function from the `textopsx` module after each change to the message. This function can help to ensure that the changes are applied correctly and that the message remains valid._ [See FAQ for more info.](../../tutorials/faq/main.md#sip-message-processing)**

## Pseudo-variables usage

Pseudo-variables can be used with many modules, among them:
Expand Down

0 comments on commit 7d6d034

Please sign in to comment.