Add documentation about textclock format

This commit is contained in:
Jordan Christiansen 2019-10-10 20:29:39 -05:00
parent e888d983ef
commit 580883add3
1 changed files with 4 additions and 2 deletions

View File

@ -28,9 +28,11 @@ if source_date_epoch and os.getenv("SOURCE_DIRECTORY") then
end
end
--- Set the clock's format
--- Set the clock's format.
-- For information about the format specifiers, see
-- [the GLib docs](https://developer.gnome.org/glib/stable/glib-GDateTime.html#g-date-time-format).
-- @property format
-- @tparam string format The new time format. This can contain pango markup
-- @tparam string format The new time format. This can contain pango markup.
function textclock:set_format(format)
self._private.format = format