Skip to content

Commit

Permalink
Note policy on incomplete snippets
Browse files Browse the repository at this point in the history
Closes Raku#4138
  • Loading branch information
coke committed Mar 4, 2023
1 parent 449d311 commit 4f51d99
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions writing-docs/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ added to insure valid compilation.
Care is taken to wrap the sample code in enough boilerplate so that no
runtime code is executed, and that a class is available if needed.

Note: because we are considering each POD code block independently,
there is no guarantee that a partial snippet will itself be compilable.
For this reason, it's fine to use `preamble` (see below) to give each
block enough information to compile. For pedagogical reasons, it's
OK to break what would otherwise be a large block of code into smaller
chunks and discuss each one separately - we still want to do our best
to compile these individual chunks.

## Skipping or finessing tests

While our goal is to test every example of Raku in the repository, some
Expand Down

0 comments on commit 4f51d99

Please sign in to comment.