Updating stats doc comments #8397
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
deepikabhavnani
approved these changes
Oct 12, 2018
There was a problem hiding this comment.
Thanks @bridadan for description and correction..Looks good to me 👍 just a small comment to address
|
@bridadan - We have additional pull request type now: "[ ] Docs update". |
|
|
||
| /** | ||
| * Fill the passed in sys stat structure with system stats. | ||
| * Fill the passed in system stat structure with system statistics. |
There was a problem hiding this comment.
Query: Should we spell out the first "stat" in the this sentence match the others, or does it stand for something other than statistics?
There was a problem hiding this comment.
lets have it as statistics everywhere
Capitalize ID for consistency.
AnotherButler
approved these changes
Oct 12, 2018
0xc0170
approved these changes
Oct 12, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Clarifying the different members of the statistics API. Also making the style of the comments more consistent.
FYI @AnotherButler
Pull request type