diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.html | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/index.html b/docs/index.html index 20dccfa..8385480 100644 --- a/docs/index.html +++ b/docs/index.html | |||
@@ -246,12 +246,11 @@ | |||
246 | </table> | 246 | </table> |
247 | 247 | ||
248 | <p> | 248 | <p> |
249 | Requiring the module follows Lua 5.2+ rules: the module is not available under the global name "lanes", but has to be accessed through <tt>require</tt>'s return value. | 249 | Requiring the module follows Lua 5.2+ rules: the module is not available under the global name "lanes", but has to be accessed through <tt>require</tt>'s return value.<br/> |
250 | </p> | 250 | Lanes needs <tt>"base"</tt>, <tt>"string"</tt> and <tt>"table"</tt> to be initialized beforehand (plus <tt>"jit"</tt> for LuaJIT). |
251 | <p> | ||
252 | After lanes is required, it is necessary to call <tt>lanes.configure()</tt>, which is the only function exposed by the module at this point. Calling <tt>lanes.configure()</tt> will perform one-time initializations and make the rest of the API available. | ||
253 | </p> | 251 | </p> |
254 | <p> | 252 | <p> |
253 | After lanes is required, it is necessary to call <tt>lanes.configure()</tt>, which is the only function exposed by the module at this point. Calling <tt>lanes.configure()</tt> will perform one-time initializations and make the rest of the API available.<br/> | ||
255 | At the same time, <tt>lanes.configure()</tt> itself will be replaced by another function that raises an error if called again with differing arguments, if any. | 254 | At the same time, <tt>lanes.configure()</tt> itself will be replaced by another function that raises an error if called again with differing arguments, if any. |
256 | </p> | 255 | </p> |
257 | <p> | 256 | <p> |