-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add @timev, @timed documentation [av skip] #11319
Conversation
@@ -742,7 +742,15 @@ System | |||
|
|||
.. function:: @time | |||
|
|||
A macro to execute an expression, printing the time it took to execute and the total number of bytes its execution caused to be allocated, before returning the value of the expression. | |||
A macro to execute an expression, printing the time it took to execute, the number of allocations, the total number of bytes its execution caused to be allocated, before returning the value of the expression. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
number of allocations, and the total number of bytes
4fd3dd8
to
6b3198c
Compare
|
||
.. function:: @timev | ||
|
||
This is a verbose version of the ``@timev`` macro, it first prints the same information as ``@time``, then any non-zero memory allocation counters, and then returns the value of the expression. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missed this - it's not a verbose version of itself, it's a verbose version of @time
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duh! Sorry!
IIRC |
Only if you're really sure you pass |
@tkelman Noted. |
It is probably useful to document the meaning of each line for
|
I'll look at it, it is internally stored as an signed int, and you have to add in a collection value... when it is negative, I think it looks in the pool do do allocations... |
This adds documentation for the
@timev
macro which I added with #11186, as well as documenting the@timed
macro, which was already present, but not undocumented.