From 6ed69cb132dbfdd0b264352359f887a2061ad459 Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 6 Jul 2015 12:58:24 +0200 Subject: [PATCH] stats: document append_property return value --- player/lua/stats.lua | 5 +++-- 1 file 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