aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2016-09-05 20:11:26 -0400
committerJustin M. Keyes <justinkz@gmail.com>2016-09-05 20:15:31 -0400
commitd9d2c2fcc0a6e371355a8f2942cf8cb0f3189385 (patch)
tree7b10c30fa8c4baf12aec3b6182fda61d7ca52382
parentdf99c6493d1bef3c6abc0a851ff678025fd53775 (diff)
downloadrneovim-d9d2c2fcc0a6e371355a8f2942cf8cb0f3189385.tar.gz
rneovim-d9d2c2fcc0a6e371355a8f2942cf8cb0f3189385.tar.bz2
rneovim-d9d2c2fcc0a6e371355a8f2942cf8cb0f3189385.zip
doc: clarify reltime()
Closes #5301
-rw-r--r--runtime/doc/eval.txt13
1 files changed, 11 insertions, 2 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 92f9a0f656..6678b273e0 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -5480,14 +5480,23 @@ reltime([{start} [, {end}]]) *reltime()*
the item depends on the system. It can be passed to
|reltimestr()| to convert it to a string or |reltimefloat()|
to convert to a float.
- Without an argument it returns the current time.
- With one argument is returns the time passed since the time
+
+ Without an argument it returns the current "relative time",
+ an implementation-dependent value meaningful only in the
+ context of:
+ 1. comparison with other reltime() results
+ 2. |reltimestr()|
+ 3. |reltimefloat()|
+
+ With one argument it returns the time passed since the time
specified in the argument.
With two arguments it returns the time passed between {start}
and {end}.
The {start} and {end} arguments must be values returned by
reltime().
+ Note: |localtime()| returns the current (non-relative) time.
+
reltimefloat({time}) *reltimefloat()*
Return a Float that represents the time value of {time}.
Unit of time is seconds.