summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2019-12-19 11:19:15 +0100
committerwm4 <wm4@nowhere>2019-12-19 11:19:15 +0100
commitb054abe7fca640531246c4fd5397faaacbc6dd8e (patch)
tree2e9694882090c93c041d34c020cc7e1ed3a3f99a
parent2c5cb2c53f38580696af4085bb257f0112e92a42 (diff)
downloadmpv-b054abe7fca640531246c4fd5397faaacbc6dd8e.tar.bz2
mpv-b054abe7fca640531246c4fd5397faaacbc6dd8e.tar.xz
manpage: lua: mention what happens on unavailable properties
Kind of as big one if the user unexpectedly gets nil instead of a value.
-rw-r--r--DOCS/man/lua.rst4
1 files changed, 4 insertions, 0 deletions
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.