Skip to content

Commit 3a4fc35

Browse files
committed
Merge pull request #154 from bnoordhuis/io-docs-fixups
Fix broken links in IO documentation.
2 parents 40beaa4 + 1a92c41 commit 3a4fc35

File tree

7 files changed

+22
-22
lines changed

7 files changed

+22
-22
lines changed

doc/Type/IO/Handle.pod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Return the number of lines read from the file.
117117
118118
Return the remaining content of the file from the current file position
119119
(which may have been set by previous reads or by C<seek>.) If the
120-
adverb C<:bin> is provided a L<Buf|/lib/Type/Buf> will be returned,
120+
adverb C<:bin> is provided a L<Buf> will be returned,
121121
otherwise the return will be a C<Str> with the optional encoding C<:enc>.
122122
123123
=head2 method close

doc/Type/IO/Path.pod

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ not absolute. The optional named parameter C<test> can specify a file test
196196
that should be applied to the target path if the operation is successful.
197197
The default C<test> is that the directory is readable.
198198
199-
If the directory change is successful then the L<IO::Path|/lib/Type/IO/Path>
199+
If the directory change is successful then the L<IO::Path>
200200
representing the target directory is returned, otherwise it will
201201
L<fail|/routine/fail> with L<X::IO::Chdir>.
202202
@@ -211,7 +211,7 @@ http://en.wikipedia.org/wiki/File_system_permissions#Numeric_notation>
211211
specified as an integer (thought still subject to L<umask|
212212
http://en.wikipedia.org/wiki/Umask>).
213213
214-
Throws an exception of type L<X::IO::Mkdir|/type/X::IO::Mkdir> if the
214+
Throws an exception of type L<X::IO::Mkdir> if the
215215
directory cannot be created, except for the C<*@dirnames> form which
216216
returns the names of the directories that were successfully created.
217217
@@ -223,7 +223,7 @@ returns the names of the directories that were successfully created.
223223
Remove the given directory if it is empty.
224224
225225
Returns C<True> on success. Throws an exception of type
226-
L<X::IO::Rmdir|/type/X::IO::Rmdir> if the directory cannot be removed (e.g.
226+
L<X::IO::Rmdir> if the directory cannot be removed (e.g.
227227
the directory is not empty, or the path is not a directory).
228228
229229
=head2 routine chmod

doc/Type/IO/Socket/Async.pod

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ C<IO::Socket::Async> provides asynchronous TCP sockets, for both the
1010
server and the client side.
1111
1212
Here is the equivalent example to that in
13-
L<IO::Socket::INET|/lib/Type/IO/Socket/INET> of a simple echo server
13+
L<IO::Socket::INET> of a simple echo server
1414
that listens on port 3333:
1515
1616
=begin code
@@ -57,17 +57,17 @@ or C<listen> should be used to create a client or a server respectively.
5757
method connect(Str $host, Int $port) returns Promise
5858
5959
Attempts to connect to the TCP server specified by C<$host> and C<$port>,
60-
returning a L<Promise|/lib/Type/Promise> that will either be kept with a connected L<IO::Socket::Async> or broken if the connection cannot be made.
60+
returning a L<Promise> that will either be kept with a connected L<IO::Socket::Async> or broken if the connection cannot be made.
6161
6262
=head2 method listen
6363
6464
method listen(Str $host, Int $port) returns Supply
6565
6666
Creates a listening socket on the specified C<$host> and C<$port>, returning
67-
a L<Supply|/lib/Type/Supply> to which the accepted client L<IO::Socket::Async>s will be C<emit>ted. This L<Supply|/lib/Type/Supply> should be tapped to
67+
a L<Supply> to which the accepted client L<IO::Socket::Async>s will be C<emit>ted. This L<Supply> should be tapped to
6868
process the client connections.
6969
70-
To close the underlying listening socket the L<Supply|/lib/Type/Supply>
70+
To close the underlying listening socket the L<Supply>
7171
should be C<close>d.
7272
7373
=head2 method print
@@ -76,7 +76,7 @@ should be C<close>d.
7676
7777
Attempt to send C<$str> on the L<IO::Socket::Async> that will
7878
have been obtained indirectly via C<connect> or C<listen>, returning a
79-
L<Promise|/lib/Type/Promise> that will be kept with the number of bytes
79+
L<Promise> that will be kept with the number of bytes
8080
sent or broken if there was an error sending.
8181
8282
=head2 method write
@@ -85,33 +85,33 @@ sent or broken if there was an error sending.
8585
8686
Attempt to send the bytes in C<$b> on the L<IO::Socket::Async> that will
8787
have been obtained indirectly via C<connect> or C<listen>, returning a
88-
L<Promise|/lib/Type/Promise> that will be kept with the number of bytes
88+
L<Promise> that will be kept with the number of bytes
8989
sent or broken if there was an error sending.
9090
9191
=head2 method chars-supply
9292
9393
method chars-supply() returns Supply
9494
95-
Returns a L<Supply|/lib/Type/Supply> which can be tapped to obtain the
95+
Returns a L<Supply> which can be tapped to obtain the
9696
characters read from the connected L<IO::Socket::Async> as they arrive.
9797
9898
=head2 method bytes-supply
9999
100100
method bytes-supply() returns Supply
101101
102-
Returns a L<Supply|/lib/Type/Supply> which can be tapped to obtain
103-
the bytes (as elements of a L<Buf|/lib/Type/Buf>,) read from the
102+
Returns a L<Supply> which can be tapped to obtain
103+
the bytes (as elements of a L<Buf>,) read from the
104104
L<IO::Socket::Async> as they arrive.
105105
106106
=head2 method close
107107
108108
method close()
109109
110110
Close the connected client <IO::Socket::Async> which will have been
111-
obtained from the C<listen> L<Supply|/lib/Type/Supply> or the C<connect>
112-
L<Promise|/lib/Type/Promise>.
111+
obtained from the C<listen> L<Supply> or the C<connect>
112+
L<Promise>.
113113
114114
In order to close the underlying listening socket created by C<listen> you
115-
can simply C<close> the L<Supply|/lib/Type/Supply>.
115+
can simply C<close> the L<Supply>.
116116
117117
=end pod

doc/Type/IO/Spec.pod

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Objects of this class are not used directly but as a sub-class specific to
1010
the platform perl is running on via the C<$*SPEC> variable which will contain
1111
an object of the appropriate type.
1212
13-
The sub-classes are documeted separately with the platform specific differemces
14-
are documented in L<IO::Spec::Cygwin|/lib/Type/IO/Spec/Cygwin>, L<IO::Spec::QNX|/lib/Type/IO/Spec/QNX>, L<IO::Spec::Unix|/lib/Type/IO/Spec/Unix> and
15-
L<IO::Spec::Win32|/lib/Type/IO/Spec/Win32>.
13+
The sub-classes are documented separately, with the platform-specific
14+
differences documented in L<IO::Spec::Cygwin>, L<IO::Spec::QNX>,
15+
L<IO::Spec::Unix> and L<IO::Spec::Win32>.
1616
1717
=head2 method canonpath
1818

doc/Type/IO/Spec/Cygwin.pod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
class IO::Spec::QNX is IO::Spec { }
88
9-
This sub-class of L<IO::Spec|/lib/Type/IO/Spec> will be available from the
9+
This sub-class of L<IO::Spec> will be available from the
1010
C<$*SPEC> variable for a perl running on C<Cygwin> .
1111
1212
=head2 method canonpath

doc/Type/IO/Spec/QNX.pod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
class IO::Spec::QNX is IO::Spec { }
88
9-
This sub-class of L<IO::Spec|/lib/Type/IO/Spec> specific to QNX will be
9+
This sub-class of L<IO::Spec> specific to QNX will be
1010
available via C<$*SPEC> if the perl is running on QNX.
1111
1212
=head2 method canonpath

doc/Type/Routine.pod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ functions when the arguments are known at compile time.
119119
120120
multi sub trait_mod:<is>(Routine $r, :!$rw)
121121
122-
When a routine is modifies with this trait, its return value will be writable.
122+
When a routine is modified with this trait, its return value will be writable.
123123
This is useful when returning variables or writable elements of hashes or
124124
arrays, for example:
125125

0 commit comments

Comments
 (0)