Skip to content

Commit 53f2b99

Browse files
committed
[io grant] Document role IO's new purpose
1 parent d1d9b5c commit 53f2b99

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

doc/Type/IO.pod6

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
55
=SUBTITLE Input/output related routines
66
7-
Please note that coercion via L<Cool.IO|/type/Cool#method_IO> leads to
8-
L<IO::Path|/type/IO::Path>. This is the exception from the rule.
7+
The role provides no methods, but exists so that C<IO()> coercers, which coerce
8+
to L<IO::Path>, correctly type-check the resultant value. The role is done
9+
by L<IO::Path> and L<IO::Special>.
910
1011
=head1 Routines
1112

doc/Type/IO/Handle.pod6

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
=SUBTITLE Opened file or stream
66
7-
class IO::Handle does IO { }
7+
class IO::Handle { }
88
99
=head1 Methods
1010

doc/Type/IO/Socket.pod6

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
=SUBTITLE Network socket
66
7-
role IO::Socket does IO { ... }
7+
role IO::Socket { ... }
88
99
C<IO::Socket> contains read and write methods for sockets. It is usually used
1010
through L<IO::Socket::INET>.

doc/Type/IO/Special.pod6

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
55
=SUBTITLE Path to Special I/O device
66
7+
=for code :skip-test
8+
class IO::Special does IO { }
9+
710
Used as a L«C<$.path>|/type/IO::Handle#method_path>» attribute in special
811
standard input and output handles C<$*IN>, C<$*OUT> and C<$*ERR>. Provides
912
abridged interface of L«C<IO::Handle>|/type/IO::Handle», mostly file tests

0 commit comments

Comments
 (0)