Skip to content

Commit e66fb29

Browse files
committed
Minimize repetition in IO::Spec::*
Add a specific section in IO::Spec document with caveats about its sub-classes. Replace these caveats's mentions in IO::Spec::* documents by a reference to IO::Spec document.
1 parent 0734936 commit e66fb29

File tree

5 files changed

+12
-34
lines changed

5 files changed

+12
-34
lines changed

doc/Type/IO/Spec.pod6

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ The sub-classes are documented separately, with the platform-specific
1414
differences documented in L<IO::Spec::Cygwin|/type/IO::Spec::Cygwin>, L<IO::Spec::QNX|/type/IO::Spec::QNX>,
1515
L<IO::Spec::Unix|/type/IO::Spec::Unix> and L<IO::Spec::Win32|/type/IO::Spec::Win32>.
1616
17-
B<NOTE:> the C<IO::Spec::*> classes provide low-level path operations. Unless
17+
=head1 About sub-classes IO::Spec::*
18+
19+
The C<IO::Spec::*> classes provide low-level path operations. Unless
1820
you're creating your own high-level path manipulation routines, you don't
1921
need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path» instead.
2022
21-
B<NOTE2:> no special validation is done by these classes (e.g. check whether
23+
Beware that no special validation is done by these classes (e.g. check whether
2224
path contains a null character). It is the job of higher-level classes, like
2325
L«C<IO::Path>|/type/IO::Path», to do that.
2426

doc/Type/IO/Spec/Cygwin.pod6

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,8 @@
99
An object of this type is available via the variable C<$*SPEC> if the
1010
Raku interpreter is running on C<Cygwin>.
1111
12-
The C<IO::Spec::*> classes provide low-level path operations. Unless
13-
you're creating your own high-level path manipulation routines, you
14-
don't need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path»
15-
instead.
16-
17-
Beware that no special validation is done by these classes (e.g. check
18-
whether path contains a null character). It is the job of higher-level
19-
classes, like L«C<IO::Path>|/type/IO::Path», to do that.
12+
About this class and its related classes also see
13+
L<IO::Spec|/type/IO::Spec>.
2014
2115
=head1 Methods
2216

doc/Type/IO/Spec/QNX.pod6

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,8 @@
99
An object of this type is available via the variable C<$*SPEC> if the
1010
Raku interpreter is running on a C<QNX> platform.
1111
12-
The C<IO::Spec::*> classes provide low-level path operations. Unless
13-
you're creating your own high-level path manipulation routines, you
14-
don't need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path»
15-
instead.
16-
17-
Beware that no special validation is done by these classes (e.g. check
18-
whether path contains a null character). It is the job of higher-level
19-
classes, like L«C<IO::Path>|/type/IO::Path», to do that.
12+
About this class and its related classes also see
13+
L<IO::Spec|/type/IO::Spec>.
2014
2115
=head1 Methods
2216

doc/Type/IO/Spec/Unix.pod6

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,8 @@
99
An object of this type is available via the variable C<$*SPEC> if the
1010
Raku interpreter is running on a Unix-like platform.
1111
12-
The C<IO::Spec::*> classes provide low-level path operations. Unless
13-
you're creating your own high-level path manipulation routines, you
14-
don't need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path»
15-
instead.
16-
17-
Beware that no special validation is done by these classes (e.g. check
18-
whether path contains a null character). It is the job of higher-level
19-
classes, like L«C<IO::Path>|/type/IO::Path», to do that.
12+
About this class and its related classes also see
13+
L<IO::Spec|/type/IO::Spec>.
2014
2115
=head1 Methods
2216

doc/Type/IO/Spec/Win32.pod6

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,8 @@
99
An object of this type is available via the variable C<$*SPEC> if the
1010
Raku interpreter is running on a Windows-like platform.
1111
12-
The C<IO::Spec::*> classes provide low-level path operations. Unless
13-
you're creating your own high-level path manipulation routines, you
14-
don't need to use C<IO::Spec::*>. Use L«C<IO::Path>|/type/IO::Path»
15-
instead.
16-
17-
Beware that no special validation is done by these classes (e.g. check
18-
whether path contains a null character). It is the job of higher-level
19-
classes, like L«C<IO::Path>|/type/IO::Path», to do that.
12+
About this class and its related classes also see
13+
L<IO::Spec|/type/IO::Spec>.
2014
2115
=head1 Methods
2216

0 commit comments

Comments
 (0)