Minor improvements to benchmark files #325
Merged
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.
Description & Motivation
It is proposed to make small changes to the benchmark files:
BENCHMARKING.md
toREADME.md
so that the information is immediately displayed when going to thebenchmark
directory on GitHubREADME.md
match the order of the header template used in code files; add new line breaksfinal
, remove empty functions)Related Issue(s)
No.
Testing
Not required - the functionality does not change.
Backwards-compatibility
No.
Documentation
The benchmark information file (
README.md
) will change slightly.