From c1c33d539df7b4230b0e404d5f9850b9c3a3572a Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Sun, 15 Jun 2025 16:14:20 -0400 Subject: [PATCH] docs: add a small line for info --- docs/api/yarn.md | 22 +--------------------- emmyLuaDocs/yarn.lua | 4 ---- golibs/yarn/yarn.go | 1 + 3 files changed, 2 insertions(+), 25 deletions(-) diff --git a/docs/api/yarn.md b/docs/api/yarn.md index 2d007812..3f5420c9 100644 --- a/docs/api/yarn.md +++ b/docs/api/yarn.md @@ -10,6 +10,7 @@ menu: ## Introduction Yarn is a simple multithreading library. Threads are individual Lua states, so they do NOT share the same environment as the code that runs the thread. +Bait and Commanders are shared though, so you *can* throw hooks from 1 thread to another. Example: @@ -21,27 +22,6 @@ local t = yarn.thread(print) t 'printing from another lua state!' ``` -## Functions -||| -|----|----| -|thread(fun) -> @Thread|Creates a new, fresh Yarn thread.| - -
-
-

-yarn.thread(fun) -> Thread - - - -

- -Creates a new, fresh Yarn thread. -`fun` is the function that will run in the thread. - -#### Parameters -This function has no parameters. -
- ## Types
diff --git a/emmyLuaDocs/yarn.lua b/emmyLuaDocs/yarn.lua index 3fa4f431..1b0961ed 100644 --- a/emmyLuaDocs/yarn.lua +++ b/emmyLuaDocs/yarn.lua @@ -2,8 +2,4 @@ local yarn = {} ---- Creates a new, fresh Yarn thread. ---- `fun` is the function that will run in the thread. -function yarn.thread(fun) end - return yarn diff --git a/golibs/yarn/yarn.go b/golibs/yarn/yarn.go index 0a3d5114..9121e70b 100644 --- a/golibs/yarn/yarn.go +++ b/golibs/yarn/yarn.go @@ -1,6 +1,7 @@ // multi threading library // Yarn is a simple multithreading library. Threads are individual Lua states, // so they do NOT share the same environment as the code that runs the thread. +// Bait and Commanders are shared though, so you *can* throw hooks from 1 thread to another. /* Example: