Browse Source

Document Channel:pop timeout units;

bjorn 5 years ago
parent
commit
dd80cd6e60
2 changed files with 3 additions and 3 deletions
  1. 1 1
      api/init.lua
  2. 2 2
      api/lovr/thread/Channel/pop.lua

+ 1 - 1
api/init.lua

@@ -22972,7 +22972,7 @@ return {
                     {
                     {
                       name = "wait",
                       name = "wait",
                       type = "number",
                       type = "number",
-                      description = "How long to wait for the message to be popped.  `true` can be used to wait forever and `false` can be used to avoid waiting.",
+                      description = "How long to wait for a message to be popped, in seconds.  `true` can be used to wait forever and `false` can be used to avoid waiting.",
                       default = "false"
                       default = "false"
                     }
                     }
                   },
                   },

+ 2 - 2
api/lovr/thread/Channel/pop.lua

@@ -10,8 +10,8 @@ return {
       type = 'number',
       type = 'number',
       default = 'false',
       default = 'false',
       description = [[
       description = [[
-        How long to wait for the message to be popped.  `true` can be used to wait forever and
-        `false` can be used to avoid waiting.
+        How long to wait for a message to be popped, in seconds.  `true` can be used to wait forever
+        and `false` can be used to avoid waiting.
       ]]
       ]]
     }
     }
   },
   },