Skip to content

Commit bf1c68b

Browse files
committed
Cleanup of RakuAST:Doc overview document
1 parent 70eadad commit bf1c68b

1 file changed

Lines changed: 16 additions & 20 deletions

File tree

‎doc/Type/RakuAST/Doc.rakudoc‎

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,29 @@
44

55
=SUBTITLE Namespace for holding RakuDoc related classes
66

7-
package RakuAST::Doc { }
7+
=begin code
8+
package RakuAST::Doc { }
9+
=end code
810

911
The C<RakuAST::Doc> package serves as a common namespace for all
1012
classes that provide RakuDoc functionality.
1113

12-
Support for L<C<RakuAST>|/type/RakuAST> functionality is available in language version
13-
C<6.e+> and was added in Rakudo compiler release 2023.02. In earlier
14-
language versions it is only available when specifying:
15-
16-
use experimental :rakuast;
17-
1814
=head1 Classes
1915

2016
Relations between the C<RakuAST::Doc::> classes:
2117

2218
=for code :lang<ascii-diagram>
23-
RakuAST::Doc::Block
24-
\- paragraphs
25-
|- string
26-
|- RakuAST::Doc::Paragraph
27-
| \- atoms
28-
| |- string
29-
| \- RakuAST::Doc::Markup
30-
| \- atoms
31-
| |- string
32-
| \- RakuAST::Doc::Markup
33-
\- RakuAST::Doc::Block
19+
RakuAST::Doc::Block
20+
\- paragraphs
21+
|- string
22+
|- RakuAST::Doc::Paragraph
23+
| \- atoms
24+
| |- string
25+
| \- RakuAST::Doc::Markup
26+
| \- atoms
27+
| |- string
28+
| \- RakuAST::Doc::Markup
29+
\- RakuAST::Doc::Block
3430

3531
Note that this structure is recursive with regards to the
3632
L«C<RakuAST::Doc::Block>|/type/RakuAST::Doc::Block» object (which can
@@ -78,7 +74,7 @@ This is L<B<example>|https://example.com>>.
7874

7975
is represented in C<RakuAST::Doc::> objects like this:
8076

81-
=begin code :preamble<use experimental :rakuast>
77+
=begin code
8278
RakuAST::Doc::Block.new(
8379
type => "rakudoc",
8480
paragraphs => (
@@ -131,7 +127,7 @@ my $foo; #= really!
131127

132128
is represented like this:
133129

134-
=begin code :preamble<use experimental :rakuast>
130+
=begin code
135131
RakuAST::VarDeclaration::Simple.new(
136132
sigil => "\$",
137133
desigilname => RakuAST::Name.from-identifier("foo")

0 commit comments

Comments
 (0)