diff options
| author | Matt T. Proud <matt.proud@gmail.com> | 2021-07-14 22:42:31 +0200 |
|---|---|---|
| committer | Ian Lance Taylor <iant@golang.org> | 2021-07-15 20:39:22 +0000 |
| commit | 0941dbca6ae805dd7b5f7871d5811b7b7f14f77f (patch) | |
| tree | 6ece81cbcc6cf287677c0bb91bc2685921523685 | |
| parent | 69728ead871f15cc1fd7e70b67e6768dd1100bae (diff) | |
| download | go-0941dbca6ae805dd7b5f7871d5811b7b7f14f77f.tar.gz go-0941dbca6ae805dd7b5f7871d5811b7b7f14f77f.zip | |
testing: clarify in docs that TestMain is advanced
Beginner and intermediate Go users periodically use TestMain when
requirements do not necessitate TestMain (exceeding least-mechanism
design). This commit expands package testing's documentation to convey
that the TestMain feature itself is somewhat low-level and potentially
unsuitable for casual testing where ordinary test functions would
suffice.
Fixes #42161
Updates #44200
Change-Id: I91ba0b048c3d6f79110fe8f0fbb58d896edca366
Reviewed-on: https://go-review.googlesource.com/c/go/+/334649
Trust: Ian Lance Taylor <iant@golang.org>
Run-TryBot: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
| -rw-r--r-- | src/testing/testing.go | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/testing/testing.go b/src/testing/testing.go index eeee0aac17..681f99ef93 100644 --- a/src/testing/testing.go +++ b/src/testing/testing.go @@ -233,6 +233,8 @@ // os.Exit(m.Run()) // } // +// TestMain is a low-level primitive and should not be necessary for casual +// testing needs, where ordinary test functions suffice. package testing import ( |