diff --git a/docs/scripting.xml b/docs/scripting.xml index d15b1a6f6..a71a09fd1 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -2608,43 +2608,43 @@ error_message describes the occurred error. booleans, and numbers. The returned function allows you to lock, try to lock, and release the mutex. It's first and only parameter is either: - - - - - Make a blocking lock on the mutex. If the mutex is busy - (another thread has a lock on it), then the thread will - yield and wait. The function returns with the mutex - locked. - - - - - - Makes a non-blocking lock on the mutex. If the mutex is - busy then it immediately returns with a return value of - false. Otherwise the mutex locks the - mutex and returns true. - - - - - - Releases the mutex and allows another thread to lock it. - If the thread does not have a lock on the mutex, an - error will be raised. - - - - - - Returns the thread locked on the mutex or nil. This - should only be used for debugging as it interferes - with finished threads from being collected. - - - + + + + + Make a blocking lock on the mutex. If the mutex is busy + (another thread has a lock on it), then the thread will + yield and wait. The function returns with the mutex + locked. + + + + + + Makes a non-blocking lock on the mutex. If the mutex is + busy then it immediately returns with a return value of + false. Otherwise the mutex locks the + mutex and returns true. + + + + + + Releases the mutex and allows another thread to lock it. + If the thread does not have a lock on the mutex, an + error will be raised. + + + + + + Returns the thread locked on the mutex or nil. This + should only be used for debugging as it interferes + with finished threads from being collected. + + +