Skip to content

fix some typos in Test2::V1 POD #1054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mauke wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −15
Open

fix some typos in Test2::V1 POD #1054

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions lib/Test2/V1.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ thrown.
=item C<!EXPORT_NAME>

You can prefix an export name with C<!> to exclude it at import time. This is
really only usedul when combined with C<-import> or C<-i>.
really only useful when combined with C<-import> or C<-i>.

=item C<< EXPORT_NAME => { -as => "ALT_NAME" } >>

Expand Down Expand Up @@ -360,16 +360,16 @@ C<my_ok()>

=head1 PRAGMAS AND PLUGINS

B<NO PRAGMAS ARE ENABLED BY DEFAULT>
B<ONLY THE EXIT SUMMARY PLUGIN IS STILL ENABLED BY DEFAULT>
B<NO PRAGMAS ARE ENABLED BY DEFAULT.>
B<ONLY THE EXIT SUMMARY PLUGIN IS STILL ENABLED BY DEFAULT.>

This is a significant departure from L<Test2::V0>.

You can enable all of these with the C<-pP> argument, which is short for
C<-plugins, -pragmas>. C<P> is short for plugins, and C<p> is short for
pragmas. When using the single-letter form they may both be together following
a single dash, and can be in any order. They may also be combined with C<i> to
bring in all imports. C<-p> or C<-P> ont heir own are also perfectly valid.
bring in all imports. C<-p> or C<-P> on their own are also perfectly valid.

=over 4

Expand Down Expand Up @@ -434,7 +434,7 @@ See L<Test2::Env> for a list of meaningful environment variables.

=head1 API FUNCTIONS

See L<Test2::API> for these
See L<Test2::API> for these.

=over 4

Expand Down Expand Up @@ -487,7 +487,7 @@ can have additional tools added to it.

Note that you MAY override original tools such as ok(), note(), etc. by
importing different copies this way. The first time you do this there should be
no warnings or errors. If you pull in multiple tools of the same name an
no warnings or errors. If you pull in multiple tools of the same name, a
redefine warning is likely.

This also effects exports:
Expand Down Expand Up @@ -532,7 +532,7 @@ Used to allow the handle to stomp on an existing namespace (NOT RECOMMENDED).
Set the base class from which functions should be inherited. Normally this is
set to L<Test2::V1::Base>.

Another interesting use case is to have multiple handles that use eachothers
Another interesting use case is to have multiple handles that use each other's
namespaces as base classes:

use Test2::V1;
Expand All @@ -550,9 +550,9 @@ namespaces as base classes:

=head1 EXAMPLE USE CASES

=head2 OVERRIDING INCLUDED TOOLS WITH ALTERNATES
=head2 OVERRIDING INCLUDED TOOLS WITH ALTERNATIVES

Lets say you want to use the L<Test2::Warnings> version of C<warning()>,
Let's say you want to use the L<Test2::Warnings> version of C<warning()>,
C<warnings()> instead of the L<Test2::Tools::Warnings> versions, and also
wanted to import everything else L<Test2::Warnings> provides.

Expand Down Expand Up @@ -1047,11 +1047,11 @@ scripts, but they can get in the way in many cases.
Many people would put custom strict/warnings settings at the top of their
tests, only to have them wiped out when they use L<Test2::V0>.

=item Assumptions of UTF8
=item Assumptions of UTF-8

Occasionally you do not want this assumption. The way it impacts all your
regular and test handles, as well as how your source is read, can be a problem
if you are not working with UTF8, or have other plans entirly.
if you are not working with UTF-8, or have other plans entirely.

=item Huge default set of exports, which can grow

Expand All @@ -1063,16 +1063,16 @@ a point not to break/remove exports, but there is no such commitment about
adding new ones.

Now the only default export is C<T2()> which gives you a handle where all the
tools we expose are provided as methods. You can also use the L<T2> module (Not
tools we expose are provided as methods. You can also use the L<T2> module (not
bundled with Test-Simple) for use with an identical number of keystrokes, which
allow you to leverage the prototypes on the original tool subroutines.
allows you to leverage the prototypes on the original tool subroutines.

=back

=head1 SOURCE

The source code repository for Test2-Suite can be found at
F<https://github.com/Test-More/test-more/>.
L<https://github.com/Test-More/test-more/>.

=head1 MAINTAINERS

Expand All @@ -1097,6 +1097,6 @@ Copyright Chad Granum E<lt>exodist@cpan.orgE<gt>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

See F<http://dev.perl.org/licenses/>
See L<https://dev.perl.org/licenses/>.

=cut
Loading