Skip to content

Commit ce8f432

Browse files
committed
heading level refactor
use =TITLE as top level heading, and then start with =head1 methods this effectively lowers the rank of most headings by one
1 parent 3274031 commit ce8f432

File tree

17 files changed

+153
-151
lines changed

17 files changed

+153
-151
lines changed

lib/Any.pod

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
=begin pod
22
3-
=head1 Any
3+
=TITLE class Any
44
55
class Any is Mu { ... }
66
77
While C<Mu> is the root of the Perl 6 class hirarchy, C<Any> is the class
88
that serves as a default base class for new classes, and as the base class for
99
most built-in classes.
1010
11-
=head2 Methods
11+
=head1 Methods
1212
13-
=head3 ACCEPTS
13+
=head2 ACCEPTS
1414
1515
multi method ACCEPTS(Any:D: Mu $other)
1616
1717
Returns C<True> if C<$other === self> (ie it checks object identity).
1818
19-
=head3 any
19+
=head2 any
2020
2121
Interprets the invocant as a list and creates an C<any>-Junction from it.
2222
23-
=head3 all
23+
=head2 all
2424
2525
Interprets the invocant as a list and creates an C<all>-Junction from it.
2626
27-
=head3 one
27+
=head2 one
2828
2929
Interprets the invocant as a list and creates an C<one>-Junction from it.
3030
31-
=head3 none
31+
=head2 none
3232
3333
Interprets the invocant as a list and creates an C<none>-Junction from it.
3434

lib/Bool.pod

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
=begin pod
22
3-
=head1 Bool
3+
=TITLE enum Bool
44
55
enum Bool <False True>
66
77
An enum for boolean true/false decisions
88
9-
=head2 Operators
9+
=head1 Operators
1010
11-
=head3 prefix:<?>
11+
=head2 prefix:<?>
1212
1313
multi sub prefix:<?>(Mu) returns Bool:D
1414
1515
Coerces its argument to C<Bool>.
1616
17-
=head3 prefix:<so>
17+
=head2 prefix:<so>
1818
1919
multi sub prefix:<so>(Mu) returns Bool:D
2020

lib/Buf.pod

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
=begin pod
22
3-
=head1 Buf
3+
=TITLE class Buf
44
55
class Buf does Positional { ... }
66
@@ -11,27 +11,27 @@ It can be used to for writing to IO handles as C<$io.write($buf)>.
1111
In the abstract it is just a list of integers, so
1212
for example indexing into a C<Buf> with C<.[$idx]> returns an C<Int>.
1313
14-
=head2 Methods
14+
=head1 Methods
1515
16-
=head3 new
16+
=head2 new
1717
1818
method new(*@codes)
1919
2020
Creates a C<Buf> from a list of integers.
2121
22-
=head3 Bool
22+
=head2 Bool
2323
2424
multi method Bool(Buf:D:)
2525
2626
Returns C<False> if and only if the buffer is empty.
2727
28-
=head3 elems
28+
=head2 elems
2929
3030
multi method elems(Buf:D:) returns Int:D
3131
3232
Returns the number of elements of the buffer.
3333
34-
=head3 decode
34+
=head2 decode
3535
3636
multi method decode(Buf:D: Str:D $encoding = 'UTF-8') returns Str:D
3737

lib/Code.pod

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
=begin pod
22
3-
=head1 Code
3+
=TITLE Code
44
55
class Code is Any does Callable { ... }
66
@@ -10,9 +10,9 @@ directly of type C<Code>, most code objects (such as those resulting
1010
from blocks, subroutines or methods) will be of some subclass of C<Code>.
1111
1212
13-
=head2 Methods
13+
=head1 Methods
1414
15-
=head3 ACCEPTS
15+
=head2 ACCEPTS
1616
1717
multi method ACCEPTS(Code:D: Mu $topic)
1818
@@ -21,7 +21,7 @@ However, when called on a code object that takes no arguments, the code
2121
object is invoked with no arguments and C<$topic> is dropped. The
2222
result of the call is returned.
2323
24-
=head3 arity
24+
=head2 arity
2525
2626
method arity(Code:D:) returns Int:D
2727
@@ -36,7 +36,7 @@ code object's C<Signature> do not contribute, nor do named parameters.
3636
say &args.arity; # 1
3737
say &slurpy.arity; # 2
3838
39-
=head3 count
39+
=head2 count
4040
4141
method count(Code:D:) returns Real:D
4242
@@ -52,14 +52,14 @@ C<count> will return C<Inf>. Named parameters do not contribute.
5252
say &args.count; # 2
5353
say &slurpy.count; # Inf
5454
55-
=head3 signature
55+
=head2 signature
5656
5757
multi method signature(Code:D:) returns Signature:D
5858
5959
Returns the C<Signature> object for this code object, which describes
6060
its parameters.
6161
62-
=head3 Str
62+
=head2 Str
6363
6464
multi method Str(Code:D:) returns Str:D
6565

lib/Cool.pod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
=begin pod
22
3-
=head1 Cool
3+
=TITLE Cool
44
55
class Cool is Any { }
66

lib/Enum.pod

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
=begin pod
22
3-
=head1 Enum
3+
=TITLE class Enum
44
55
class Enum does Associative { ... }
66
77
An C<Enum> consists of a key and a value. It is the immutable version of
88
C<Pair> (which inherits from Enum).
99
10-
=head2 Methods
10+
=head1 Methods
1111
12-
=head3 key
12+
=head2 key
1313
1414
multi method key(Enum:D:)
1515
1616
Returns the key part of the Enum.
1717
18-
=head3 value
18+
=head2 value
1919
2020
multi method value(Enum:D:)
2121
2222
Returns the value part of the Enum.
2323
24-
=head3 invert
24+
=head2 invert
2525
2626
multi method invert(Enum:D:) returns Enum:D
2727

lib/Int.pm

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
=begin pod
22
3-
=head1 Int
3+
=TITLE class Int
44
55
class Int is Cool does Real { ... }
66
77
C<Int> objects store integral numbers of arbitrary size. C<Int>s are immutable.
88
9-
=head2 Operators
9+
=head1 Operators
1010
11-
=head3 div
11+
=head2 div
1212
1313
multi sub infix:<div>(Int:D, Int:D) returns Int:D
1414

0 commit comments

Comments
 (0)