benchmark icon indicating copy to clipboard operation
benchmark copied to clipboard
verified publisher icon ruby

Document that default FORMAT includes total time

Open paarthmadan opened this issue 4 years ago • 0 comments

This pull request contains two changes.

  1. Correctly documenting the default behaviour of the format method.

The default FORMAT string is currently: "%10.6u %10.6y %10.6t %10.6r\n" This represents user time, system time, total time, and elapsed real time, respectively.

The current documentation forgets to mention that total time is included.

  1. Clarify that total time includes the children's user and system times.

Certain references to the total time suggest that they are a sum of user CPU time and system CPU time. I think we should be more specific and highlight that the total includes the children's user and system CPU times as it is not readily apparent until looking much deeper into the documentation and codebase.

paarthmadan avatar Oct 04 '21 19:10 paarthmadan