bevyengine / bevyengine/bevy-website

Validation tests for embedded examples in the new book

Open
#2,560 0 comments 0 reactions 0 assignees View on GitHub
A-Book C-Code Quality C-Feature D-Modest S-Needs-Design
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

The Bevy Book chapters have lots of embedded examples in doctest format, but many of them have errors - either syntax errors or calling APIs that don't exist. We should have some sort of test that we can run locally to ensure the integrity of the examples.

Contributor guide

Open the contributing guide

Research direction

Start by surveying the Bevy Book chapters and their embedded doctest examples to determine how the examples are currently represented and run locally. Done means a repeatable local test detects examples with syntax errors or calls to APIs that do not exist.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.