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.

Sign up for GitHub

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

Jump to bottom

Documentation examples need testing #557

Open

JakeStanger opened this issue Apr 24, 2024 · 0 comments

Labels

Owner

JakeStanger commented Apr 24, 2024 •

edited

Loading

Some of the documentation examples may be invalid.

Unit tests should be set up to test each example snippet to ensure it can be serialized correctly.

This should be simple enough, but requires:

Pulling out each snippet into its own file
Building documentation to include these snippets

JakeStanger added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment