Permalink
Browse files

Fix documentation of instantiations modes of the `lgtunit::benchmark/…

…3-4` predicates
  • Loading branch information...
pmoura committed Oct 10, 2017
1 parent 5d711ae commit 24c3591d70de93539da1b3f200f8da2a18b07e46
Showing with 13 additions and 9 deletions.
  1. +4 −0 RELEASE_NOTES.md
  2. +1 −1 docs/index.html
  3. +4 −4 docs/lgtunit_0.html
  4. +4 −4 tools/lgtunit/lgtunit.lgt
View
@@ -24,7 +24,11 @@ RELEASE NOTES
3.12.1 - November ??, 2017
==========================
Tools
-----
* FIXED: The documentation of the instantiations modes of the predicates
`lgtunit::benchmark/3-4`.
3.12.0 - October 10, 2017
View
@@ -16,6 +16,6 @@ <h1>Documentation index</h1>
<li><a href="entity_index.html">Entity index</a></li>
<li><a href="predicate_index.html">Predicate index</a></li>
</ul>
<p>Generated on Mon Oct 9 19:32:03 BST 2017</p>
<p>Generated on Tue Oct 10 21:46:14 BST 2017</p>
</body>
</html>
View
@@ -23,11 +23,11 @@ <h1 class="code">lgtunit</h1>
</dd>
<dt class="key">version:</dt>
<dd class="value">
<code>4.9</code>
<code>4.11</code>
</dd>
<dt class="key">date:</dt>
<dd class="value">
<code>2017/10/9</code>
<code>2017/10/10</code>
</dd>
</dl>
<dl class="properties">
@@ -311,7 +311,7 @@ <h3 id="benchmark/3" class="code">benchmark/3</h3>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>benchmark(+callable,+integer,-float) &ndash; one</code>
<code>benchmark(@callable,+positive_integer,-float) &ndash; one</code>
</dd>
</dl>
</div>
@@ -335,7 +335,7 @@ <h3 id="benchmark/4" class="code">benchmark/4</h3>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>benchmark(+callable,+integer,+atom,-float) &ndash; one</code>
<code>benchmark(@callable,+positive_integer,+atom,-float) &ndash; one</code>
</dd>
</dl>
</div>
@@ -26,9 +26,9 @@
:- set_logtalk_flag(debug, off).
:- info([
version is 4.9,
version is 4.11,
author is 'Paulo Moura',
date is 2017/10/09,
date is 2017/10/10,
comment is 'A unit test framework supporting predicate clause coverage, determinism testing, input/output testing, quick-check testing, and multiple test dialects.'
]).
@@ -119,15 +119,15 @@
:- public(benchmark/3).
:- meta_predicate(benchmark(0, *, *)).
:- mode(benchmark(+callable, +integer, -float), one).
:- mode(benchmark(@callable, +positive_integer, -float), one).
:- info(benchmark/3, [
comment is 'Benchmarks a goal by repeating it the specified number of times and returning the total execution time in seconds. Goals that may throw an exception should be wrapped by the catch/3 control construct.',
argnames is ['Goal', 'Repetitions', 'Time']
]).
:- public(benchmark/4).
:- meta_predicate(benchmark(0, *, *, *)).
:- mode(benchmark(+callable, +integer, +atom, -float), one).
:- mode(benchmark(@callable, +positive_integer, +atom, -float), one).
:- info(benchmark/4, [
comment is 'Benchmarks a goal by repeating it the specified number of times and returning the total execution time in seconds using the given clock (cpu or wall). Goals that may throw an exception should be wrapped by the catch/3 control construct.',
argnames is ['Goal', 'Repetitions', 'Clock', 'Time']

0 comments on commit 24c3591

Please sign in to comment.