@@ -234,17 +234,15 @@ This test harness library does the following things:
234234Do's, don'ts & things to keep in mind
235235-------------------------------------
236236
237- Here's a few examples of things you probably should and shouldn't do
237+ Here are a few examples of things you probably should and shouldn't do
238238when writing tests.
239239
240240Do:
241241
242- - Put as much code as possible inside test_expect_success and other
243- assertions.
242+ - Put all code inside test_expect_success and other assertions.
244243
245244 Even code that isn't a test per se, but merely some setup code
246- should be inside a test assertion if at all possible. Test scripts
247- should only have trivial code outside of their assertions.
245+ should be inside a test assertion.
248246
249247 - Chain your test assertions
250248
@@ -280,16 +278,15 @@ Don't:
280278
281279 - Break the TAP output
282280
283- The raw output from your test might be interpreted by a TAP
284- harness. You usually don't have to worry about that. TAP harnesses
285- will ignore everything they don't know about, but don't step on
286- their toes in these areas:
281+ The raw output from your test may be interpreted by a TAP harness. TAP
282+ harnesses will ignore everything they don't know about, but don't step
283+ on their toes in these areas:
287284
288285 - Don't print lines like "$x..$y" where $x and $y are integers.
289286
290287 - Don't print lines that begin with "ok" or "not ok".
291288
292- A TAP harness expect a line that begins with either "ok" and "not
289+ TAP harnesses expect a line that begins with either "ok" and "not
293290 ok" to signal a test passed or failed (and our harness already
294291 produces such lines), so your script shouldn't emit such lines to
295292 their output.
@@ -301,9 +298,7 @@ Don't:
301298
302299Keep in mind:
303300
304- - That what you print to stderr and stdout is usually ignored
305-
306- Inside <script> part, the standard output and standard error
301+ - Inside <script> part, the standard output and standard error
307302 streams are discarded, and the test harness only reports "ok" or
308303 "not ok" to the end user running the tests. Under --verbose, they
309304 are shown to help debugging the tests.
0 commit comments