📝 Update docstring for syncify(), fix name of parameter raise_sync_error (remove unused parameter name check_called_from_async) (#113)

Co-authored-by: Sebastián Ramírez <[email protected]>

Author: giladsheffer

asyncer/_main.py

@@ -256,14 +256,14 @@ def syncify(
     By default this is expected to be used from a worker thread. For example inside
     some function passed to `asyncify()`.
 
-    But if you set `check_called_from_async` to `False`, you can also use this function
+    But if you set `raise_sync_error` to `False`, you can also use this function
     in a non-async context: without an async event loop. For example, from a
     blocking/regular function called at the top level of a Python file. In that case,
     if it is not being called from inside a worker thread started from an async context
     (e.g. this is not called from a function that was called with `asyncify()`) it will
     run `async_function` in a new async event loop with `anyio.run()`.
 
-    This functionality with `check_called_from_async` is there only to allow using
+    This functionality with `raise_sync_error` is there only to allow using
     `syncify()` in codebases that are used by async code in some cases and by blocking
     code in others. For example, during migrations from blocking code to async code.
 
@@ -285,7 +285,9 @@ async def do_work(arg1, arg2, kwarg1="", kwarg2=""):
 
     `async_function`: an async function to be called in the main thread, in the async
         event loop
-    `check_called_from_async`: If set to `False`
+    `raise_sync_error`: If set to `False`, when used in a non-async context (without
+        an async event loop), it will run `async_function` in a new async event loop,
+        instead of raising an exception.
 
     ## Return