Skip to content

Commit 7db1423

Browse files
documentation fixes throughout for affect vs effect
and a few other typo fixes
1 parent e790de8 commit 7db1423

20 files changed

+28
-31
lines changed

Changes

+2-2
Original file line numberDiff line numberDiff line change
@@ -1038,7 +1038,7 @@ Test-Simple 1.302013_013 2016-03-08 09:19:39-08:00 America/Los_Angeles (TRIAL RE
10381038

10391039
Test-Simple 1.302013_012 2016-01-28 20:38:16-08:00 America/Los_Angeles (TRIAL RELEASE)
10401040

1041-
- $Level effects all contexts once Test::Builder is loaded
1041+
- $Level affects all contexts once Test::Builder is loaded
10421042
- Requires Test2 0.000023
10431043

10441044
Test-Simple 1.302013_011 2016-01-14 21:55:28-08:00 America/Los_Angeles (TRIAL RELEASE)
@@ -1395,7 +1395,7 @@ Test-Simple 0.89_01 2009-Jun-23 15:13-08:00 EDT
13951395
Test Fixes
13961396
* Small fixes for integration with the Perl core
13971397
[bleadperl eaa0815147e13cd4ab5b3d6ca8f26544a9f0c3b4]
1398-
* exit code tests could be effected by errno when PERLIO=stdio
1398+
* exit code tests could be affected by errno when PERLIO=stdio
13991399
[bleadperl c76230386fc5e6fba9fdbeab473abbf4f4adcbe3]
14001400

14011401

lib/Test/Builder.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -2568,7 +2568,7 @@ If you fail more than 254 tests, it will be reported as 254.
25682568
25692569
In perl 5.8.1 and later, Test::Builder is thread-safe. The test number is
25702570
shared by all threads. This means if one thread sets the test number using
2571-
C<current_test()> they will all be effected.
2571+
C<current_test()> they will all be affected.
25722572
25732573
While versions earlier than 5.8.1 had threads they contain too many
25742574
bugs to support.

lib/Test/Builder/Tester.pm

+3-3
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ Actually performs the output check testing the tests, comparing the
280280
data (with C<eq>) that we have captured from L<Test::Builder> against
281281
what was declared with C<test_out> and C<test_err>.
282282
283-
This takes name/value pairs that effect how the test is run.
283+
This takes name/value pairs that affect how the test is run.
284284
285285
=over
286286
@@ -438,8 +438,8 @@ sub color {
438438
439439
Test::Builder::Tester does not handle plans well. It has never done anything
440440
special with plans. This means that plans from outside Test::Builder::Tester
441-
will effect Test::Builder::Tester, worse plans when using Test::Builder::Tester
442-
will effect overall testing. At this point there are no plans to fix this bug
441+
will affect Test::Builder::Tester, worse plans when using Test::Builder::Tester
442+
will affect overall testing. At this point there are no plans to fix this bug
443443
as people have come to depend on it, and Test::Builder::Tester is now
444444
discouraged in favor of C<Test2::API::intercept()>. See
445445
L<https://github.com/Test-More/test-more/issues/667>

lib/Test/Tutorial.pod

+1-1
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ turn it into a real test.
509509

510510
=head2 Testing with taint mode.
511511

512-
Taint mode is a funny thing. It's the globalest of all global
512+
Taint mode is a funny thing. It's the most global of all global
513513
features. Once you turn it on, it affects I<all> code in your program
514514
and I<all> modules used (and all the modules they use). If a single
515515
piece of code isn't taint clean, the whole thing explodes. With that

lib/Test2/API.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -1300,7 +1300,7 @@ formatter being used.
13001300
In both cases events are generated and stored in an array. This array is
13011301
eventually used to populate the C<subevents> attribute on the
13021302
L<Test2::Event::Subtest> event that is generated at the end of the subtest.
1303-
This flag has no effect on this part, it always happens.
1303+
This flag has no effect on this part: it always happens.
13041304
13051305
At the end of the subtest, the final L<Test2::Event::Subtest> event is sent to
13061306
the formatter.

lib/Test2/API/InterceptResult/Event.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,7 @@ that subtest results can be turned into instances of it on demand.
591591
592592
=item $copy = $event->clone
593593
594-
Create a deep copy of the event. Modifying either event will not effect the
594+
Create a deep copy of the event. Modifying either event will not affect the
595595
other.
596596
597597
=back

lib/Test2/AsyncSubtest.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -713,7 +713,7 @@ L<Test2::Event::Ok> event.
713713
=item silent => 1
714714
715715
This will prevent finish from generating a final L<Test2::Event::Subtest>
716-
event. This effectively ends the subtest without it effecting the parent
716+
event. This effectively ends the subtest without it affecting the parent
717717
subtest (or top level test).
718718
719719
=item no_plan => 1

lib/Test2/Compare.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ listed first:
277277
=item implicit_end => 1
278278
279279
This option toggles array/hash boundaries. If this is true then no extra hash
280-
keys or array indexes will be allowed. This setting effects generated compare
280+
keys or array indexes will be allowed. This setting affects generated compare
281281
objects as well as any passed in.
282282
283283
=item use_regex => 1

lib/Test2/Event.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ match.
414414
415415
=item $e->add_amnesty({tag => $TAG, details => $DETAILS});
416416
417-
This can be used to add amnesty to this event. Amnesty only effects failing
417+
This can be used to add amnesty to this event. Amnesty only affects failing
418418
assertions in most cases, but some formatters may display them for passing
419419
assertions, or even non-assertions as well.
420420

lib/Test2/Manual/Anatomy/EndToEnd.pm

+4-4
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,12 @@ If a new context was created, context-creation hooks will fire.
155155
=item $!, $@, $?, and $^E are restored.
156156
157157
We make sure $!, $@, $?, and $^E are unchanged at this point so that changes we
158-
made will not effect anything else. This is done in case something inside the
158+
made will not affect anything else. This is done in case something inside the
159159
context construction accidentally changed these vars.
160160
161161
=item The context is returned.
162162
163-
You have a shiney new context object, or a clone of the existing context.
163+
You have a shiny new context object, or a clone of the existing context.
164164
165165
=back
166166
@@ -196,9 +196,9 @@ event can modify global test state.
196196
197197
=item The global test state is updated to reflect the event.
198198
199-
If the event effects test count then the count will be incremented. If the
199+
If the event affects test count then the count will be incremented. If the
200200
event causes failure then the failure count will be incremented. There are a
201-
couple other ways the global state can be effected as well.
201+
few other ways the global state can be affected as well.
202202
203203
=item The event is sent to the formatter
204204

lib/Test2/Manual/Anatomy/Event.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Test2::Manual::Anatomy::Event - The internals of events
1414
1515
=head1 DESCRIPTION
1616
17-
Events are how tools effect global state, and pass information along to the
17+
Events are how tools affect global state, and pass information along to the
1818
harness, or the human running the tests.
1919
2020
=head1 HISTORY

lib/Test2/Manual/Anatomy/Hubs.pm

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ connection to the parent hub, and usually does not have a formatter.
5656
5757
=head1 WHEN SHOULD I ADD A HUB TO THE STACK?
5858
59-
Any time you want to intercept or block events from effecting the test state.
59+
Any time you want to intercept or block events from affecting the test state.
6060
Adding a new hub is essentially a way to create a sandbox where you have
6161
absolute control over what events do. Adding a new hub insures that the main
62-
test state will not be effected.
62+
test state will not be affected.
6363
6464
=head1 WHERE IS THE STACK?
6565

lib/Test2/Manual/Anatomy/IPC.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The IPC system is activated by loading L<Test2::IPC>. This makes hubs
2222
process/thread aware, and makes them forward events along to the parent
2323
process/thread as necessary.
2424
25-
=head1 HOW DOES THE IPC SYSTEM EFFECT EVERYTHING?
25+
=head1 HOW DOES THE IPC SYSTEM AFFECT EVERYTHING?
2626
2727
L<Test2::API> and L<Test2::API::Instance> have some behaviors that trigger if
2828
L<Test2::IPC> is loaded before the global state is initialized. Mainly an IPC

lib/Test2/Manual/Testing/Todo.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ todo).
7171
=head1 HOW THE TODO TOOLS WORK UNDER THE HOOD
7272
7373
The L<Test2::Todo> library gets the current L<Test2::Hub> instance and adds a
74-
filter. The filter that is added will set the todo and effective pass fields on
74+
filter. The filter that is added will set the C<todo> and C<effective_pass> fields on
7575
any L<Test2::Event::Ok> events that pass through the hub. The filter also
7676
converts L<Test2::Event::Diag> events into L<Test2::Event::Note> events.
7777

lib/Test2/Manual/Tooling/Nesting.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ the start of your function, and release it at the end... yes it is that simple.
8080
8181
See, that was easy. With these 2 additional lines we know have proper file+line
8282
reporting. The nested tools will find the context we acquired here, and know to
83-
use it's file and line numbers.
83+
use its file and line numbers.
8484
8585
=head3 THE OLD WAY (DO NOT DO THIS ANYMORE)
8686

lib/Test2/Manual/Tooling/Testing.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ No events or contexts generated within the intercept codeblock will have any
3838
effect on the outside testing state. The C<intercept> function completely
3939
isolates the tools called within.
4040
41-
B<Note:> Plugins and things that effect global API state may not be fully
41+
B<Note:> Plugins and things that affect global API state may not be fully
4242
isolated. C<intercept> is intended specifically for event isolation.
4343
4444
The C<intercept> function will return an arrayref containing all the events

lib/Test2/Plugin.pm

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Test2::Plugin - Documentation for plugins
1818
1919
=head1 DESCRIPTION
2020
21-
Plugins are packages that cause behavior changes, or other side effects for the
21+
Plugins are packages that cause behavior changes, or other side-effects for the
2222
test file that loads them. They should not export any functions, or provide any
2323
tools. Plugins should be distinct units of functionality.
2424

lib/Test2/Suite.pm

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ any number of plugins.
4747
4848
=back
4949
50-
If you want to write something that both exports new functions, and effects
50+
If you want to write something that both exports new functions, and affects
5151
behavior, you should write both a Tools distribution, and a Plugin distribution,
5252
then a Bundle that loads them both. This is important as it helps avoid the
5353
problem where a package exports much-desired tools, but
54-
also produces undesirable side effects.
54+
also produces undesirable side-effects.
5555
5656
=head1 INCLUDED BUNDLES
5757

lib/Test2/Tools.pm

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ Tools are packages that export test functions, typically all related to a
2222
specific aspect of testing. If you have a couple different categories of
2323
exports then you may want to break them into separate modules.
2424
25-
Tools should export testing functions. Loading tools B<should not> have side
25+
Tools should export testing functions. Loading tools B<should not> have side-
2626
effects, or alter the behavior of other tools. If you want to alter behaviors
27-
or create side effects then you probably want to write a L<Test2::Plugin>.
27+
or create side-effects then you probably want to write a L<Test2::Plugin>.
2828
2929
=head1 FAQ
3030

xt/author/pod-spell.t

-3
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,6 @@ renderer
111111
17th
112112
AHHHHHHH
113113
Dummy
114-
globalest
115114
Hmmm
116115
cid
117116
tid
@@ -212,7 +211,6 @@ getline
212211
getlines
213212
getpos
214213
getters
215-
globalest
216214
heisenbug
217215
html
218216
isnt
@@ -234,7 +232,6 @@ reftype
234232
renderer
235233
renderers
236234
setpos
237-
shiney
238235
sref
239236
str
240237
subevent

0 commit comments

Comments
 (0)