manpage: lua: mention what happens on unavailable properties

Kind of as big one if the user unexpectedly gets nil instead of a value.
This commit is contained in:
wm4 2019-12-19 11:19:15 +01:00
parent 2c5cb2c53f
commit b054abe7fc
1 changed files with 4 additions and 0 deletions

View File

@ -358,6 +358,10 @@ The ``mp`` module is preloaded, although it can be loaded manually with
of times in a row, only the last change triggers the change function. (The of times in a row, only the last change triggers the change function. (The
exact behavior depends on timing and other things.) exact behavior depends on timing and other things.)
If a property is unavailable, or on error, the value argument to ``fn`` is
``nil``. (The ``observe_property()`` call always succeeds, even if a
property does not exist.)
In some cases the function is not called even if the property changes. In some cases the function is not called even if the property changes.
This depends on the property, and it's a valid feature request to ask for This depends on the property, and it's a valid feature request to ask for
better update handling of a specific property. better update handling of a specific property.