From b054abe7fca640531246c4fd5397faaacbc6dd8e Mon Sep 17 00:00:00 2001 From: wm4 Date: Thu, 19 Dec 2019 11:19:15 +0100 Subject: manpage: lua: mention what happens on unavailable properties Kind of as big one if the user unexpectedly gets nil instead of a value. --- DOCS/man/lua.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index 5da358a12c..45fbfd62d0 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -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 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. This depends on the property, and it's a valid feature request to ask for better update handling of a specific property. -- cgit v1.2.3