Skip to content

Commit c0e7e38

Browse files
committed
Document the standard OUTPUT format for newcomers
Closes #4616
1 parent dd07b8e commit c0e7e38

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/Language/intro.rakudoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,19 @@ on the raku.org site. These include articles, books, slide
6363
presentations, and videos.
6464
=end item
6565

66+
=begin item
67+
You will see examples throughout the document, like so:
68+
69+
=for code
70+
my @a = 1, 2, 3;
71+
@a»++;
72+
say @a; # OUTPUT: «[2 3 4]␤»
73+
74+
Note on the last line, there is a comment, starting with C<# OUTPUT:>, that shows what the example outputs.
75+
The output is wrapped in C<«»> quotes (also a valid quoting construct in Raku!), and may include a C<␤>, which
76+
is the Unicode character "Symbol for Newline" - to indicates where in the actual output a literal newline would
77+
appear.
78+
79+
=end item
6680

6781
=end pod

0 commit comments

Comments
 (0)