diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-08 03:27:48 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-08 03:27:48 +0100 |
| commit | 28c2c975b118016d07212ed8e7c22ff280309f82 (patch) | |
| tree | f1552392a3d87efebd7c565c6414ae41dc208ee9 /user_guide_src/source/libraries/benchmark.rst | |
| parent | 9228f85b1b4f59cc88ba7c4addc258a7a5fd0ac0 (diff) | |
[ci skip] Add return types to library docs
Diffstat (limited to 'user_guide_src/source/libraries/benchmark.rst')
| -rw-r--r-- | user_guide_src/source/libraries/benchmark.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/user_guide_src/source/libraries/benchmark.rst b/user_guide_src/source/libraries/benchmark.rst index 7a0313f43..ddbe04869 100644 --- a/user_guide_src/source/libraries/benchmark.rst +++ b/user_guide_src/source/libraries/benchmark.rst @@ -135,18 +135,18 @@ Class Reference .. method:: mark($name) - :param string $name: the name you wish to assign to your marker - :returns: void + :param string $name: the name you wish to assign to your marker + :rtype: void Sets a benchmark marker. - .. method:: elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]]) - :param string $point1: a particular marked point - :param string $point2: a particular marked point - :param int $decimals: number of decimal places for precision - :returns: string + :param string $point1: a particular marked point + :param string $point2: a particular marked point + :param int $decimals: number of decimal places for precision + :returns: Elapsed time + :rtype: string Calculates and returns the time difference between two marked points. @@ -158,7 +158,8 @@ Class Reference .. method:: memory_usage() - :returns: string + :returns: Memory usage info + :rtype: string Simply returns the ``{memory_usage}`` marker. |