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

Ensure validity of code snippets in documentation and README #3

Open
svix-daniel opened this issue Jun 2, 2023 · 0 comments
Open
Assignees

Comments

@svix-daniel
Copy link
Contributor

Right now the code snippets in the documentation are marked as compile_fail. This is because behind the scenes, each snippet is wrapped in a synchronous function, when all the examples are async. There are most certainly ways around this, so we should fix this as soon as I have a spare moment.

Additionally @svix-onelson (in #1 (comment)) says that there's something we can do to have the same doc tests run for snippet in the README, which we should do if possible.

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