aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc André Tanner <mat@brain-dump.org>2016-12-09 19:18:51 +0100
committerMarc André Tanner <mat@brain-dump.org>2016-12-09 19:42:27 +0100
commit90524d3990e16943c7de1899b91cc4a18fc04b4e (patch)
treeb02130268b9755102659d1d95f62ca67b237f14b
parentdd1c467245ab59c8a53e8696b778511531feaebc (diff)
downloadvis-90524d3990e16943c7de1899b91cc4a18fc04b4e.tar.gz
vis-90524d3990e16943c7de1899b91cc4a18fc04b4e.tar.xz
vis-lua: add comment about possibly outdated Lua API documentation
-rw-r--r--lua/vis.lua2
-rw-r--r--vis-lua.c2
2 files changed, 3 insertions, 1 deletions
diff --git a/lua/vis.lua b/lua/vis.lua
index 98ba6e5..97350a7 100644
--- a/lua/vis.lua
+++ b/lua/vis.lua
@@ -141,7 +141,7 @@ end
--- Unsubscribe from an event.
--
-- Remove a registered event handler.
--- @tparamm string event the event name
+-- @tparam string event the event name
-- @tparam function handler the event handler to unsubscribe
-- @treturn bool whether the handler was successfully removed
events.unsubscribe = function(event, handler)
diff --git a/vis-lua.c b/vis-lua.c
index 9e94b28..6eefc13 100644
--- a/vis-lua.c
+++ b/vis-lua.c
@@ -4,6 +4,8 @@
* *WARNING:* there is no stability guarantee at this time, the API might
* change without notice!
*
+ * This document might be out of date, run `make luadoc` to regenerate it.
+ *
* @module vis
* @author Marc André Tanner
* @license ISC