You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Firstly, thank you for the effort in developing and publishing syncer.
I believe there is some potential for misunderstanding the purpose of the package, based on the current documentation and the terminology used.
The documentation suggests that syncer is an "async-to-sync converter." While this is accurate in the sense that syncer allows asynchronous functions to be executed synchronously at runtime, it could be misleading for users who might interpret this as a tool that performs static conversion of asynchronous code to synchronous code by rewriting the source code.
The confusion comes from the words "convert" or "converter". I understand that from the perspective of a developer, an imaginary "conversion" happens as "syncer" gives you the ability to run coroutines synchronously by providing you such runtime context facility. To be fair, it is what is: a provider-for-async-runtime wrapper .
The text was updated successfully, but these errors were encountered:
teocns
changed the title
Clarify the purpose of the library
Clarify the purpose of the package
Aug 21, 2024
Firstly, thank you for the effort in developing and publishing syncer.
I believe there is some potential for misunderstanding the purpose of the package, based on the current documentation and the terminology used.
The documentation suggests that syncer is an "async-to-sync converter." While this is accurate in the sense that syncer allows asynchronous functions to be executed synchronously at runtime, it could be misleading for users who might interpret this as a tool that performs static conversion of asynchronous code to synchronous code by rewriting the source code.
The confusion comes from the words "convert" or "converter". I understand that from the perspective of a developer, an imaginary "conversion" happens as "syncer" gives you the ability to run coroutines synchronously by providing you such runtime context facility. To be fair, it is what is: a provider-for-async-runtime wrapper .
The text was updated successfully, but these errors were encountered: