Improve docs for Benchmark.realtime #25
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reopening this PR from ruby/ruby here: ruby/ruby#11706
The documentation for
Benchmark.realtimedoesn't make it clear what unit is being used. I've updated the docs to specify that it uses seconds. The module level docs do mention that Benchmark.measure returns seconds, but it is easy to miss when looking at the method docs in isolation.Rails has recently deprecated the
Benchmark.msmonkeypatch (rails/rails#52746), which means there might be more people using this in Rails app, and clarifying the unit here will make it less confusing to switch to this.In addition, I have also added an example for the method.