Skip to content

Commit 7f9b27d

Browse files
committed
Tweak IterationBuffer documentation a bit
After having written tests, I noticed some properties were missing
1 parent 8898dc5 commit 7f9b27d

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

doc/Type/IterationBuffer.rakudoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,38 +29,40 @@ argument which, when specified, will be used to fill the C<IterationBuffer>.
2929

3030
method push(IterationBuffer:D: Mu \value)
3131

32-
Adds the given value at the end of the C<IterationBuffer>.
32+
Adds the given value at the end of the C<IterationBuffer> and returns the
33+
given value.
3334

3435
=head2 method unshift
3536

3637
method unshift(IterationBuffer:D: Mu \value)
3738

38-
Adds the given value at the beginning of the C<IterationBuffer>.
39+
Adds the given value at the beginning of the C<IterationBuffer> and returns
40+
the given value.
3941

4042
=head2 method append
4143

42-
method append(IterationBuffer:D: IterationBuffer:D $other)
44+
method append(IterationBuffer:D: IterationBuffer:D $other --> IterationBuffer:D)
4345

4446
Adds the contents of the other C<IterationBuffer> at the end of
45-
the C<IterationBuffer>.
47+
the C<IterationBuffer>, and returns the updated invocant.
4648

4749
=head2 method prepend
4850

49-
method prepend(IterationBuffer:D: IterationBuffer:D $other)
51+
method prepend(IterationBuffer:D: IterationBuffer:D $other --> IterationBuffer:D)
5052

5153
Adds the contents of the other C<IterationBuffer> at the beginning
52-
of the C<IterationBuffer>.
54+
of the C<IterationBuffer>, and returns the updated invocant.
5355

5456
=head2 method clear
5557

56-
method clear(IterationBuffer:D:)
58+
method clear(IterationBuffer:D: --> Nil)
5759

5860
Resets the number of elements in the C<IterationBuffer> to zero,
59-
effectively removing all data from it.
61+
effectively removing all data from it, and returns C<Nil>.
6062

6163
=head2 method elems
6264

63-
method elems(IterationBuffer:D:)
65+
method elems(IterationBuffer:D: --> Int:D)
6466

6567
Returns the number of elements in the C<IterationBuffer>.
6668

@@ -87,25 +89,25 @@ negative position values.
8789

8890
=head2 method Slip
8991

90-
method Slip(IterationBuffer:D:)
92+
method Slip(IterationBuffer:D: --> Slip:D)
9193

9294
Coerces the C<IterationBuffer> to a L<Slip|/type/Slip>.
9395

9496
=head2 method List
9597

96-
method List(IterationBuffer:D:)
98+
method List(IterationBuffer:D: --> List:D)
9799

98100
Coerces the C<IterationBuffer> to a L<List|/type/List>.
99101

100102
=head2 method Seq
101103

102-
method Seq(IterationBuffer:D:)
104+
method Seq(IterationBuffer:D: --> Seq:D)
103105

104106
Coerces the C<IterationBuffer> to a L<Seq|/type/Seq>.
105107

106108
=head2 method raku
107109

108-
method raku(IterationBuffer:D:)
110+
method raku(IterationBuffer:D: --> Str)
109111

110112
Produces a representation of the C<IterationBuffer> as a C<List>
111113
postfixed with ".IterationBuffer" to make it different from an

0 commit comments

Comments
 (0)