summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJulian <MyFakeAcc.4@googlemail.com>2015-07-06 12:58:24 +0200
committerwm4 <wm4@nowhere>2017-10-09 20:40:31 +0200
commit6ed69cb132dbfdd0b264352359f887a2061ad459 (patch)
treef6fd827f6fe95eb3b4b66623c31f83424ff828ac
parentab8b6e3c16ebcf07d00b276115158caa5dfc842b (diff)
downloadmpv-6ed69cb132dbfdd0b264352359f887a2061ad459.tar.bz2
mpv-6ed69cb132dbfdd0b264352359f887a2061ad459.tar.xz
stats: document append_property return value
-rw-r--r--player/lua/stats.lua5
1 files changed, 3 insertions, 2 deletions
diff --git a/player/lua/stats.lua b/player/lua/stats.lua
index bbc3778fac..f8f2063a82 100644
--- a/player/lua/stats.lua
+++ b/player/lua/stats.lua
@@ -156,11 +156,12 @@ end
-- Format and append a property.
--- A property whose value is either nil or empty is skipped and not appended.
+-- A property whose value is either `nil` or empty is skipped and not appended.
+-- Returns `false` in case nothing was appended, otherwise `true`.
--
-- s : Table containing key `sec`.
-- sec : Existing key in table `s`, treated as a string.
--- property: The property to query and format (using OSD representation).
+-- property: The property to query and format (based on its OSD representation).
-- attr : Optional table to overwrite certain (formatting) attributes for
-- this property.
-- exclude : Optional table containing keys which are considered invalid values