stats: document append_property return value

This commit is contained in:
Julian 2015-07-06 12:58:24 +02:00 committed by wm4
parent ab8b6e3c16
commit 6ed69cb132
1 changed files with 3 additions and 2 deletions

View File

@ -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