Skip to content

Commit

Permalink
Merge pull request #2241 from MorayJ/sentenceCasing
Browse files Browse the repository at this point in the history
Sentence case for titles/subtitles/heads in Language docs. Closes #2223
  • Loading branch information
JJ committed Aug 7, 2018
2 parents ceaa1bd + 884b443 commit 9087e95
Show file tree
Hide file tree
Showing 44 changed files with 256 additions and 256 deletions.
2 changes: 1 addition & 1 deletion doc/Language/5to6-nutshell.pod6
@@ -1,6 +1,6 @@
=begin pod :tag<convert>
=TITLE Perl 5 to Perl 6 guide - In a nutshell
=TITLE Perl 5 to Perl 6 guide - in a nutshell
=SUBTITLE How do I do what I used to do? (Perl 6 in a nutshell)
Expand Down
6 changes: 3 additions & 3 deletions doc/Language/5to6-overview.pod6
@@ -1,6 +1,6 @@
=begin pod :tag<convert>
=TITLE Perl 5 to Perl 6 guide - Overview
=TITLE Perl 5 to Perl 6 guide - overview
=SUBTITLE How do I do what I used to do?
Expand All @@ -9,7 +9,7 @@ promotional overview of Perl 6; it is intended as a technical reference
for Perl 6 learners with a strong Perl 5 background and for anyone
porting Perl 5 code to Perl 6.
=head1 Perl 6 in a Nutshell
=head1 Perl 6 in a nutshell
L<Perl 6 in a Nutshell|/language/5to6-nutshell> provides a quick overview of
things changed in syntax, operators, compound statements, regular expressions,
Expand All @@ -36,7 +36,7 @@ also provides references to ecosystem modules that provide the Perl 5 behaviour
of functions, either existing in Perl 6 with slightly different semantics
(such as C<shift>), or non-existing in Perl 6 (such as C<tie>).
=head1 Special Variables in Perl 6
=head1 Special variables in Perl 6
The L<Special Variables section|/language/5to6-perlvar> describes if and how
a lot of Perl 5's special (punctuation) variables are supported in Perl 6.
Expand Down
4 changes: 2 additions & 2 deletions doc/Language/5to6-perlfunc.pod6
@@ -1,6 +1,6 @@
=begin pod :tag<convert>
=TITLE Perl 5 to Perl 6 guide - Functions
=TITLE Perl 5 to Perl 6 guide - functions
=SUBTITLE Builtin functions in Perl 5 to Perl 6
Expand Down Expand Up @@ -29,7 +29,7 @@ Also, unless otherwise stated, the use of the term "function" here will mean a
function in the style of C<func(@args)>, while "method" will refer to a
function in the style of C<@args.func>.
=head1 Alphabetical Listing of Perl Functions
=head1 Alphabetical listing of Perl functions
=head2 Filetests
Expand Down
44 changes: 22 additions & 22 deletions doc/Language/5to6-perlop.pod6
@@ -1,6 +1,6 @@
=begin pod :tag<convert>
=TITLE Perl 5 to Perl 6 guide - Operators
=TITLE Perl 5 to Perl 6 guide - operators
=SUBTITLE Operators in Perl 5 to Perl 6: equivalencies and variations
Expand All @@ -16,14 +16,14 @@ This document is an attempt to guide you from the operators in Perl 5's C<perlo
document to their equivalents in Perl 6. For full documentation on the Perl 6
equivalents, please see the L<Perl 6 documentation|/language/operators>.
=head2 Operator Precedence and Associativity
=head2 Operator precedence and associativity
The operator precedence table is somewhat different in Perl 6 than it is in
Perl 5, so it will not be detail here. If you need to know the precedence and
associativity of a given operator in Perl 6, refer to
L<Operator Precedence|/language/operators#Operator_Precedence>.
=head2 Terms and List Operators
=head2 Terms and list operators
The things listed in Perl 5's C<perlop> document as unary and list operators in
this section tend to be things that can also be thought of as functions, such
Expand All @@ -40,7 +40,7 @@ my $scalar = (1); # *not* a list, as there is no comma
my $list = (1,); # a List in a scalar container
=end code
=head2 The Arrow Operator
=head2 The arrow operator
As you typically will not be using references in Perl 6, the arrow is
probably less useful as a dereferencing operator. If you do need to
Expand All @@ -50,7 +50,7 @@ C<$arrayref.[7]> in Perl 6 and, similarly, C<< $user->name >> becomes
C<$user.name>. The C<< => >> arrow is used for constructing Pairs, see
L<Pair term documentation|/language/terms#Pair>.
=head2 Auto-increment and Auto-decrement
=head2 Auto-increment and auto-decrement
Work as in Perl 5. The one possible caveat is that they function by
calling the C<succ> method for C<++> and the C<pred> method for C<-->.
Expand All @@ -65,7 +65,7 @@ Works as you would expect. The caveat in Perl 5's perlop about C<**>
binding more tightly than unary minus (i. e. "-2**4" evaluates as "-(2**4)"
rather than "(-2)**4)") is also true for Perl 6.
=head2 Symbolic Unary Operators
=head2 Symbolic unary operators
As in Perl 5, unary C<!> and C<-> do logical and arithmetic negation,
respectively. C<?^> is used for bitwise logical negation, which the
Expand All @@ -89,15 +89,15 @@ You can get a "reference" to a named subroutine by using the C<&> sigil:
C<$sref = &foo>. Anonymous arrays, hashes, and subs return the underlying
object during creation I<right away>: C<$sref = sub { }>.
=head2 Binding Operators
=head2 Binding operators
C<=~> and C<!~> have been replaced by C<~~> and C<!~~>, respectively. Those of
you who consider smartmatching broken in Perl 5 will be happy to hear that it
works much better in Perl 6, as the stronger typing means less guesswork.
See L<the smartmatch documentation|language/operators#index-entry-smartmatch_operator>
for a more extensive explanation of how smartmatch works in Perl 6.
=head2 Multiplicative Operators
=head2 Multiplicative operators
Binary C<*>, C</>, and C<%> do multiplication, division, and modulo,
respectively, as in Perl 5.
Expand All @@ -107,28 +107,28 @@ C<print '-' x 80;> gives you a string of 80 dashes, but for the Perl 5
behavior of C<@ones = (1) x 80;> giving you a list of 80 "1"s, you would
use C<@ones = 1 xx 80;>.
=head2 Additive Operators
=head2 Additive operators
Binary C<+> and C<-> do addition and subtraction, respectively, as you would
expect.
As C<.> is the method call operator, so binary C<~> acts as the
concatenation operator in Perl 6.
=head2 Shift Operators
=head2 Shift operators
C« << » and C« >> » have been replaced by C<< +< >> and C<< +> >>.
=head2 Named Unary Operators
=head2 Named unary operators
As noted above, you'll find these in the L<functions|/language/5to6-perlfunc>
guide.
=head2 Relational Operators
=head2 Relational operators
These all work as in Perl 5.
=head2 Equality Operators
=head2 Equality operators
C<==> and C<!=> both work as in Perl 5.
Expand All @@ -145,7 +145,7 @@ C<~~> is the smartmatch operator as in Perl 5, but it's also I<just>
the match operator in Perl 6, as noted above. For how smartmatching
works in Perl 6, see L<the smartmatch documentation|language/operators#index-entry-smartmatch_operator>.
=head2 Smartmatch Operator
=head2 Smartmatch operator
See L<the smartmatch documentation|language/operators#index-entry-smartmatch_operator>
for a more extensive explanation of how smartmatch works in Perl 6.
Expand Down Expand Up @@ -173,7 +173,7 @@ Remains in Perl 6 as C<//>. Returns the first defined operand, or else
the last operand. Also, there is a low precedence version, called
C<orelse>.
=head2 Range Operators
=head2 Range operators
In list context, C<..> operates as the range operator and should not
need to be changed. That said, there are exclusionary range operators
Expand All @@ -199,7 +199,7 @@ as flip-flop operators, even if they are little-known and probably
less used. Those operators have been replaced in Perl 6
by L<ff|/routine/ff> and L<fff|/routine/fff> respectively.
=head2 Conditional Operator
=head2 Conditional operator
The conditional operator C<? :> has been replaced
by C<?? !!>:
Expand All @@ -209,7 +209,7 @@ $x = $ok ? $yes : $no; # Perl 5
=for code :preamble<my $x;my $ok;my $yes;my $no>
$x = $ok ?? $yes !! $no; # Perl 6
=head2 Assignment Operators
=head2 Assignment operators
Although not fully documented, S03 indicates that the mathematical and
logical assignment operators should work as you would expect. The one
Expand All @@ -233,7 +233,7 @@ not separated into numeric and string versions (C<&=>, etc., vs. C<&.=>, etc.),
as that feature is currently experimental in Perl 5 itself - although, again,
this is not specifically documented.
=head2 Comma Operator
=head2 Comma operator
The comma operator works mostly as expected, but technically it
creates L<Lists|/type/List>) or separates arguments in function
Expand All @@ -246,7 +246,7 @@ but in Perl 6 constructs Pair objects, rather than just functioning as
a separator. If you are trying to just literally translate a line of
Perl 5 code to Perl 6, it should behave as expected.
=head2 List Operators (Rightward)
=head2 List operators (rightward)
Like the Named Unary Operators, you'll find these discussed under
L<Functions|/language/5to6-perlfunc>.
Expand All @@ -267,7 +267,7 @@ version of C<^^>.
Additionally, there is a low precedence version of C<//>, called C<orelse>.
=head2 Quote and Quote-like Operators
=head2 Quote and quote-like operators
For all the gory details on quoting constructs, see
L<quoting|/language/quoting>.
Expand Down Expand Up @@ -326,7 +326,7 @@ Similarly, you get escaping and interpolation based on your quoting operator,
i. e. literals with C<Q>, backslash escapes with C<q>, and interpolation with
C<qq>.
=head2 I/O Operators
=head2 I/O operators
The full details on Input/Output in Perl 6 can be found at
L<io|/language/io>.
Expand Down Expand Up @@ -370,7 +370,7 @@ C<1 while foo();> works in the same way as it does in Perl 5, however it
generates a warning. In Perl 6 the idiom is now written as
C<Nil while foo();> instead.
=head2 Bitwise String Operators
=head2 Bitwise string operators
Documented individually above, but to summarize...
Expand Down
22 changes: 11 additions & 11 deletions doc/Language/5to6-perlsyn.pod6
@@ -1,6 +1,6 @@
=begin pod :tag<convert>
=TITLE Perl 5 to Perl 6 guide - Syntax
=TITLE Perl 5 to Perl 6 guide - syntax
=SUBTITLE Syntactic differences between Perl 5 and Perl 6
Expand All @@ -19,7 +19,7 @@ attempt to guide you from how things work in Perl 5 to the equivalents
in Perl 6. For full documentation on the Perl 6 syntax, please see the
Perl 6 documentation.
=head1 Free Form
=head1 Free form
Perl 6 is still I<largely> free form. However, there are a few instances
where the presence or lack of whitespace is now significant. For
Expand Down Expand Up @@ -63,7 +63,7 @@ if #`( why would I ever write an inline comment here? ) True {
As in Perl 5, you can use pod directives to create multiline comments, with
C<=begin comment> before and C<=end comment> after the comment.
=head2 Truth and Falsehood
=head2 Truth and falsehood
The one difference between Perl 5 truth and Perl 6 truth is that,
unlike Perl 5, Perl 6 treats the string C<"0"> as true. Numeric C<0>
Expand All @@ -72,7 +72,7 @@ numeric to get it to be false. Perl 6, additionally has an actual
Boolean type, so, in many cases, True and False may be available to
you without having to worry about what values count as true and false.
=head2 Statement Modifiers
=head2 Statement modifiers
Mostly, statement modifiers still work, with a few exceptions.
Expand All @@ -84,13 +84,13 @@ In Perl 6, you cannot use the form C<do {...} while $x>. You will want
to replace C<do> in that form with C<repeat>. Similarly for C<do {...}
until $x>.
=head2 Compound Statements
=head2 Compound statements
The big change from Perl 5 is that C<given> is not experimental or disabled by
default in Perl 6. For the details on C<given> see
L<this page|/language/control#given>.
=head2 Loop Control
=head2 Loop control
C<next>, C<last>, and C<redo> have not changed from Perl 5 to Perl 6.
Expand Down Expand Up @@ -123,20 +123,20 @@ for 1..5 {
}
=end code
=head2 For Loops
=head2 For loops
As noted above, C-style C<for> loops are not called C<for> loops in
Perl 6. They are just C<loop> loops. To write an infinite loop, you do
not need to use the C idiom of C<loop (;;) {...}>, but may just omit
the spec completely: C<loop {...}>
=head2 Foreach Loops
=head2 Foreach loops
In Perl 5, C<for>, in addition to being used for C-style C<for> loops, is a
synonym for C<foreach>. In Perl 6, C<for> is just used for C<foreach> style
loops.
=head2 Switch Statements
=head2 Switch statements
Perl 6 has actual switch statements, provided by C<given> with the individual
cases handled by C<when> and C<default>. The basic syntax is:
Expand Down Expand Up @@ -173,7 +173,7 @@ for ^10 {
For what is planned for C<goto>, see L<https://design.perl6.org/S04.html#The_goto_statement>.
=head2 The Ellipsis Statement
=head2 Ellipsis statement
C<...> (along with C<!!!> and C<???>) are used to create stub
declarations. This is a bit more complicated than the use of C<...> in
Expand All @@ -183,7 +183,7 @@ details. That said, there doesn't seem to be an I<obvious> reason why it
shouldn't still fulfill the role it did in Perl 5, despite its role
being expanded in Perl 6.
=head2 PODs: Embedded Documentation
=head2 PODs: embedded documentation
Pod has changed between Perl 5 and Perl 6. Probably the biggest
difference is that you need to enclose your pod between C<=begin pod>
Expand Down
6 changes: 3 additions & 3 deletions doc/Language/5to6-perlvar.pod6
@@ -1,6 +1,6 @@
=begin pod :tag<convert>
=TITLE Perl 5 to Perl 6 guide - Special Variables
=TITLE Perl 5 to Perl 6 guide - special variables
=SUBTITLE A comparison of special variables in Perl 5 and Perl 6
Expand All @@ -21,7 +21,7 @@ please see the Perl 6 documentation for each of them.
X<|Special Variables (Perl 5)>
=head2 General Variables
=head2 General variables
=item $ARG
Expand Down Expand Up @@ -534,7 +534,7 @@ Not implemented in Perl 6.
There are no built-in formats in Perl 6.
=head2 Error Variables
=head2 Error variables
Because of how error variables have changed in Perl 6, they will not be detailed
here individually.
Expand Down
2 changes: 1 addition & 1 deletion doc/Language/concurrency.pod6
Expand Up @@ -768,7 +768,7 @@ C<protect> returns whatever the code block returns.
Because C<protect> will block any threads that are waiting to execute
the critical section the code should be as quick as possible.
=head1 Safety Concerns
=head1 Safety concerns
Some shared data concurrency issues are less obvious than others.
For a good general write-up on this subject see this L<blog post|https://6guts.wordpress.com/2014/04/17/racing-to-writeness-to-wrongness-leads/>.
Expand Down
4 changes: 2 additions & 2 deletions doc/Language/containers.pod6
Expand Up @@ -315,7 +315,7 @@ Methods generally don't care whether their invocant is in a scalar, so
maps over a list of three elements, not of one.
=head1 Self-Referential Data
=head1 Self-referential data
Containers types, including C<Array> and C<Hash>, allow you to create
self-referential structures.
Expand Down Expand Up @@ -366,7 +366,7 @@ and C<%> sigiled variables gives the constraint for values:
my Int %h;
say %h.VAR.of; # OUTPUT: «(Int)␤»
=head2 Definedness Constraints
=head2 Definedness constraints
A container can also enforce a variable to be defined. Put a smiley in the declaration:
Expand Down
2 changes: 1 addition & 1 deletion doc/Language/control.pod6
@@ -1,6 +1,6 @@
=begin pod :tag<perl6>
=TITLE Control Flow
=TITLE Control flow
=SUBTITLE Statements used to control the flow of execution
Expand Down
2 changes: 1 addition & 1 deletion doc/Language/exceptions.pod6
Expand Up @@ -84,7 +84,7 @@ Note that the match target is a role. To allow user defined exceptions to match
in the same manner, they must implement the given role. Just existing in the
same namespace will look alike but won't match in a C<CATCH> block.
=head2 Exception handlers and enclosing blocks
=head2 Exception handlers and enclosing blocks
After a CATCH has handled the exception, the block enclosing the C<CATCH> block
is exited.
Expand Down

0 comments on commit 9087e95

Please sign in to comment.