Skip to content

Ensure validity of code snippets in documentation and README #3

@svix-daniel

Description

@svix-daniel

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.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions