Skip to content

Commit 56256d0

Browse files
committed
[io grant] Minor formatting improvements in IO::Special
1 parent 1cd7de0 commit 56256d0

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

doc/Type/IO/Special.pod6

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
33
=TITLE class IO::Special
44
5-
=SUBTITLE Represent a Standard I/O device
5+
=SUBTITLE Path to Special I/O device
66
7-
This provides a similar interface for the special standard input and output
8-
handles C<$*IN>, C<$*OUT> and C<$*ERR> to that of L<IO::Path|/type/IO::Path>
9-
for regular files. It is typically returned by the L<path method|/type/IO::Handle#method_path>
10-
of those handles so that they can be used interchangeably with the handles of
11-
regular files.
7+
Used as a L«C<$.path>|/type/IO::Handle#method_path>» attribute in special
8+
standard input and output handles C<$*IN>, C<$*OUT> and C<$*ERR>. Provides
9+
abridged interface of L«C<IO::Handle>|/type/IO::Handle», mostly file tests
10+
and stringification.
1211
1312
=head1 Methods
1413
@@ -17,29 +16,28 @@ regular files.
1716
=for code :skip-test
1817
method new(:$!what!)
1918
20-
The constructor has a single required named argument C<what> that will be
21-
'<STDIN>', '<STDOUT>' or '<STDERR>' as appropriate. It is unlikely that you
22-
will ever need to construct one of these objects yourself however as it
19+
The constructor has a single required named argument C<:what> that will be
20+
C«'<STDIN>'», C«'<STDOUT>'», or C«'<STDERR>'», as appropriate. It is unlikely
21+
that you will ever need to construct one of these objects yourself however as it
2322
will be done for you when the special handles are initialised.
2423
2524
=head2 method WHICH
2625
2726
method WHICH(IO::Special:D: --> Str)
2827
29-
This returns a string which identifies the object.
28+
This returns a string that identifies the object.
3029
3130
=head2 method Str
3231
3332
method Str(IO::Special:D:)
3433
35-
This returns '<STDIN>', '<STDOUT>' or '<STDERR>' as appropriate.
34+
This returns C«'<STDIN>'», C«'<STDOUT>'», or C«'<STDERR>'» as appropriate.
3635
3736
=head2 method IO
3837
3938
method IO(IO::Special:D: --> IO::Special)
4039
41-
This returns the C<IO::Special> object, it is provided for
42-
conformance to the C<IO::Path> interface.
40+
Returns the invocant.
4341
4442
=head2 method e
4543
@@ -63,7 +61,7 @@ The 'file' file test operator, always returns C<False>.
6361
6462
method s(IO::Special:D: --> Int)
6563
66-
The 'size' file test operator, always returns 0.
64+
The 'size' file test operator, always returns C<0>.
6765
6866
=head2 method l
6967
@@ -86,31 +84,32 @@ The 'write access' file test operator, returns C<True> if this is
8684
the standard output or standard error handle, C<False> if it is
8785
the standard input.
8886
89-
9087
=head2 method x
9188
9289
method x(IO::Special:D: --> Bool)
9390
9491
The 'execute access' file test operator, always returns C<False>.
9592
96-
9793
=head2 method modified
9894
9995
method modified(IO::Special:D: --> Instant)
10096
101-
The last modified time always returns an undefined L<Instant>.
97+
The last modified time always returns an L«C<Instant>|/type/Instant» type
98+
object.
10299
103100
=head2 method accessed
104101
105102
method accessed(IO::Special:D: --> Instant)
106103
107-
The last accessed time always returns an undefined L<Instant>
104+
The last accessed time always returns an L«C<Instant>|/type/Instant» type
105+
object.
108106
109107
=head2 method changed
110108
111109
method changed(IO::Special:D: --> Instant)
112110
113-
The last changed time always returns an undefined L<Instant>
111+
The last changed time always returns an L«C<Instant>|/type/Instant» type
112+
object.
114113
115114
=head2 method mode
116115

0 commit comments

Comments
 (0)