Skip to content
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

Document that default FORMAT includes total time #12

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

paarthmadan
Copy link

@paarthmadan paarthmadan commented Oct 4, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant