Skip to content

Commit 57e9971

Browse files
committed
Proofread several documents
Changes include minor rewording, text reflow, replacing indented code samples with =code directives-wrapped code samples, etc.
1 parent d242616 commit 57e9971

File tree

4 files changed

+312
-219
lines changed

4 files changed

+312
-219
lines changed

doc/Language/about.pod6

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44
55
=SUBTITLE Meta-documentation
66
7-
This document collection represents the on-going effort to document the Perl 6 programming
8-
language with the goals of being: comprehensive; easy to use; easy to
9-
navigate; and useful to both newcomers and experienced Perl 6
10-
programmers.
7+
This document collection represents the on-going effort to document the
8+
Perl 6 programming language with the goals of being: comprehensive,
9+
easy to use, easy to navigate, and useful to both newcomers and experienced
10+
Perl 6 programmers.
1111
1212
An HTML version of the documentation is located online at
1313
L<https://docs.perl6.org>.
1414
15-
The official source for this documentation is located at L<perl6/doc on GitHub|https://github.com/perl6/doc>.
15+
The official source for this documentation is located at
16+
L<perl6/doc on GitHub|https://github.com/perl6/doc>.
1617
1718
This particular document is a quick overview of the process
18-
described in more detail in L<CONTRIBUTING on GitHub|https://github.com/perl6/doc/blob/master/CONTRIBUTING.md>.
19+
described in more detail in
20+
L<CONTRIBUTING on GitHub|https://github.com/perl6/doc/blob/master/CONTRIBUTING.md>.
1921
This document also provides a short introduction to writing Perl 6
2022
Pod files, which can be rendered into HTML and other formats.
2123
@@ -33,13 +35,15 @@ To generate HTML from the Pod files, you'll need:
3335
=item A recent version of the Rakudo Perl 6 compiler
3436
3537
=item The Perl 6 modules Pod::To::HTML, Pod::To::BigPage, and URI::Escape
36-
(can be installed via L<zef|https://github.com/ugexe/zef>).
38+
which all can be installed via L<zef|https://github.com/ugexe/zef>. For
39+
instance, C<zef install Pod::To::HTML> to install Pod::To::HTML.
3740
3841
=item B<Optional>: L<GraphViz|https://www.graphviz.org>, for creating graphs
39-
of the relationships between Perl 6 types
42+
of the relationships between Perl 6 types.
4043
41-
=item B<Optional>: L<Atom Highlights|https://github.com/atom/highlights> and L<language-perl6|https://atom.io/packages/language-perl6>, for syntax
42-
highlighting
44+
=item B<Optional>: L<Atom Highlights|https://github.com/atom/highlights> and
45+
L<language-perl6|https://atom.io/packages/language-perl6>, for syntax
46+
highlighting.
4347
4448
To generate the documentation into the C<html/> folder, run:
4549
@@ -76,7 +80,9 @@ documentable. So, in:
7680
7781
Some paragraphs, followed by some code:
7882
79-
my Code $examples = "amazing";
83+
=begin code
84+
my Code $examples = "amazing";
85+
=end code
8086
8187
Mind === blown.
8288
@@ -96,7 +102,8 @@ Documentables may contain other documentables. Class documentables, for
96102
example, often contain the methods the class implements.
97103
98104
Definitions must be in one of the following forms to be recognized as
99-
the start of a documentable named, say, þ. First the code in the document source:
105+
the start of a documentable named, say, þ. First the code in the document
106+
source:
100107
101108
=begin code
102109
@@ -133,8 +140,9 @@ is always considered a definition)
133140
These items should now be searchable by using the search field in the HTML docs.
134141
135142
You can add emphasis with bold (B<V< B<> >>) or italicized (B<V< I<> >>),
136-
with or without code formatting (B<V< C<> >>). Due to current parser limitations,
137-
special steps have to be taken to use B<V< X<> >> with other formatting codes; for example:
143+
with or without code formatting (B<V< C<> >>). Due to current parser
144+
limitations, special steps have to be taken to use B<V< X<> >> with other
145+
formatting codes; for example:
138146
139147
=begin code :lang<pod6>
140148
=item X<B<foo>|foo> a fancy subroutine
@@ -144,8 +152,8 @@ renders like this
144152
145153
=item X<B<foo>|foo> a fancy subroutine
146154
147-
Notice that text after a pipe ('|') has no formatting. Also note that B<V< C<> >>
148-
preserves spaces and treats text as verbatim.
155+
Notice that text after a pipe ('|') has no formatting. Also note that
156+
B<V< C<> >> preserves spaces and treats text as verbatim.
149157
=end pod
150158

151159
# vim: expandtab softtabstop=4 shiftwidth=4 ft=perl6

doc/Language/community.pod6

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,17 @@ of Perl and of the community." - Larry Wall
1212
=head1 The Perl 6 community
1313
1414
There is a large presence on the C<#perl6> channel on C<freenode.net>,
15-
who are happy to provide support and answer questions. More resources can be found in the L<perl6.org community page|https://perl6.org/community/>. L<Camelia|https://perl6.org/>, the multi-color butterfly with P 6 in her wings, is the symbol of this diverse and welcoming community. We use extensively
16-
the L<C<#perl6>|https://perl6.org/community/irc> IRC channel for communication, questions and simply hanging out. Check out this L<IRC lingo|http://www.ircbeginner.com/ircinfo/abbreviations.html> resource for the abbreviations frequently used there. L<StackOverflow|https://stackoverflow.com/questions/tagged/perl6> is also a great resource for asking questions and helping others with their Perl 6 problems and challenges.
15+
who are happy to provide support and answer questions. More resources can be
16+
found in the L<perl6.org community page|https://perl6.org/community/>.
17+
L<Camelia|https://perl6.org/>, the multi-color butterfly with P 6 in her
18+
wings, is the symbol of this diverse and welcoming community. We use
19+
extensively the L<C<#perl6>|https://perl6.org/community/irc> IRC channel for
20+
communication, questions and simply hanging out. Check out this
21+
L<IRC lingo|http://www.ircbeginner.com/ircinfo/abbreviations.html> resource
22+
for the abbreviations frequently used there.
23+
L<StackOverflow|https://stackoverflow.com/questions/tagged/perl6> is also a
24+
great resource for asking questions and helping others with their Perl 6
25+
problems and challenges.
1726
1827
=head1 Perl 6 Weekly
1928
@@ -24,7 +33,13 @@ resource to know what is going on in the Perl community now.
2433
2534
=head1 Perl 6 Advent calendar
2635
27-
The Perl 6 community publishes every December an L<Advent Calendar|https://perl6advent.wordpress.com/>, with Perl 6 tutorials every day until Christmas. Organization and assignment of days is done through the different Perl 6 channels and the L<Perl6/advent|https://github.com/perl6/advent> repository. If you want to participate, it starts organization by the end of October, so check out the channels above for that.
36+
The Perl 6 community publishes every December an
37+
L<Advent Calendar|https://perl6advent.wordpress.com/>, with Perl 6 tutorials
38+
every day until Christmas. Organization and assignment of days is done through
39+
the different Perl 6 channels and the
40+
L<Perl6/advent|https://github.com/perl6/advent> repository. If you want to
41+
participate, its organization starts by the end of October, so check out
42+
the channels above to keep up to date.
2843
2944
=end pod
3045

0 commit comments

Comments
 (0)