aboutsummaryrefslogtreecommitdiffstats
path: root/lib/eunit/doc
diff options
context:
space:
mode:
authorRichard Carlsson <[email protected]>2012-07-17 18:27:29 +0200
committerFredrik Gustafsson <[email protected]>2012-08-10 10:57:22 +0200
commit7b1897b9cf0ef125a567004745b211698a976bd9 (patch)
tree99e6b52d21b0c995a1c9d9bee0e5a4983b6bed51 /lib/eunit/doc
parent99070064280a7141220fac2ccad8e73acde16091 (diff)
downloadotp-7b1897b9cf0ef125a567004745b211698a976bd9.tar.gz
otp-7b1897b9cf0ef125a567004745b211698a976bd9.tar.bz2
otp-7b1897b9cf0ef125a567004745b211698a976bd9.zip
add {test,M,F} as a better variant of {M,F} and make the latter obsolete
Diffstat (limited to 'lib/eunit/doc')
-rw-r--r--lib/eunit/doc/overview.edoc7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/eunit/doc/overview.edoc b/lib/eunit/doc/overview.edoc
index ad449cb6fc..42d70a6963 100644
--- a/lib/eunit/doc/overview.edoc
+++ b/lib/eunit/doc/overview.edoc
@@ -723,8 +723,11 @@ A <em>simple test object</em> is one of the following:
```fun some_function/0'''
```fun some_module:some_function/0'''
</li>
- <li>A pair of atoms `{ModuleName, FunctionName}', referring to the
- function `ModuleName:FunctionName/0'</li>
+ <li>A tuple `{test, ModuleName, FunctionName}', where `ModuleName' and
+ `FunctionName' are atoms, referring to the function
+ `ModuleName:FunctionName/0'</li>
+ <li>Obsolete: a pair of atoms `{ModuleName, FunctionName}', equivalent to
+ `{test, ModuleName, FunctionName}' if nothing else matches first. </li>
<li>A pair `{LineNumber, SimpleTest}', where `LineNumber' is a
nonnegative integer and `SimpleTest' is another simple test
object. `LineNumber' should indicate the source line of the test.