Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the purpose of the package #7

Open
teocns opened this issue Aug 21, 2024 · 0 comments
Open

Clarify the purpose of the package #7

teocns opened this issue Aug 21, 2024 · 0 comments

Comments

@teocns
Copy link

teocns commented 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 .

@teocns teocns changed the title Clarify the purpose of the library Clarify the purpose of the package Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant