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

Updating stats doc comments #8397

Merged
merged 2 commits into from Oct 13, 2018

Conversation

Projects
None yet
5 participants
@bridadan
Contributor

bridadan commented Oct 12, 2018

Description

Clarifying the different members of the statistics API. Also making the style of the comments more consistent.

FYI @AnotherButler

Pull request type

[ ] Fix
[x] Refactor
[ ] Target update
[ ] Functionality change
[ ] Breaking change

@bridadan bridadan requested a review from deepikabhavnani Oct 12, 2018

@deepikabhavnani

This comment has been minimized.

Contributor

deepikabhavnani commented on platform/mbed_stats.h in ddedc15 Oct 12, 2018

Number of bytes to store heap stats and overhead bytes of memory allocator

@deepikabhavnani

Thanks @bridadan for description and correction..Looks good to me 👍 just a small comment to address

@cmonr cmonr added the needs: review label Oct 12, 2018

@cmonr cmonr requested a review from AnotherButler Oct 12, 2018

@deepikabhavnani

This comment has been minimized.

Contributor

deepikabhavnani commented Oct 12, 2018

@bridadan - We have additional pull request type now: "[ ] Docs update".

uint32_t compiler_version; /**< Compiler version */
} mbed_stats_sys_t;
/**
* Fill the passed in sys stat structure with system stats.
* Fill the passed in system stat structure with system statistics.

This comment has been minimized.

@AnotherButler

AnotherButler Oct 12, 2018

Contributor

Query: Should we spell out the first "stat" in the this sentence match the others, or does it stand for something other than statistics?

This comment has been minimized.

@deepikabhavnani

deepikabhavnani Oct 12, 2018

Contributor

lets have it as statistics everywhere

Edit mbed_stats.h
Capitalize ID for consistency.

@0xc0170 0xc0170 added needs: CI and removed needs: review labels Oct 12, 2018

@cmonr cmonr merged commit 82c4ce6 into ARMmbed:master Oct 13, 2018

11 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/cloud-client-test Success
Details
jenkins-ci/unittests Success
Details
travis-ci/astyle Passed, 656 files (+0 files)
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 9091 cycles (-869 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8372B (+0.00%)
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment