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

Fix doxygen comments and spelling errors #8409

Merged
merged 1 commit into from Oct 13, 2018

Conversation

Projects
None yet
4 participants
@SenRamakri
Contributor

SenRamakri commented Oct 12, 2018

Description

Fix comments and naming in enums

Pull request type

[x] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change
@@ -265,7 +266,7 @@ typedef enum _mbed_module_type {
MBED_MODULE_KERNEL,
MBED_MODULE_NETWORK_STACK,
MBED_MODULE_HAL,
MBED_MODULE_NETWORK_STACKMODULE_MEMORY_SUBSYSTEM,
MBED_MODULE_MEMORY_SUBSYSTEM,

This comment has been minimized.

@deepikabhavnani

deepikabhavnani Oct 12, 2018

Contributor

Changing the actual enum name could be breaking for someone already using it.
Please do not update this in docs

@deepikabhavnani

Enum should not be update. Please change it

@cmonr cmonr merged commit e547e3d 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 10318 cycles (+358 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
@AnotherButler

This comment has been minimized.

Contributor

AnotherButler commented Oct 16, 2018

@deepikabhavnani Were your requested changes fixed before this was merged?

@cmonr

This comment has been minimized.

Contributor

cmonr commented Oct 16, 2018

Whoops. @deepikabhavnani this small change should probably be reversed. Missed this due to the auto-merge with the rollup

@deepikabhavnani

This comment has been minimized.

Contributor

deepikabhavnani commented Oct 16, 2018

@deepikabhavnani Were your requested changes fixed before this was merged?

No

@deepikabhavnani this small change should probably be reversed.

Yes. @SenRamakri - Please revert the enum change. It should not be part of doc change and not in patch release as well

@cmonr

This comment has been minimized.

Contributor

cmonr commented Oct 18, 2018

For the time being, I've marked this for 5.10.3. If the PR that fixes the enum change is ready for code freeze tomorrow, I'll bring this back in
.

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