Skip to content
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 casing for "chip" in comments #85

Merged
merged 1 commit into from
Mar 23, 2020

Conversation

pan-apple
Copy link
Contributor

Problem

Code has mixed use of Chip, CHIP and chip in the comments

Summary of Changes

Use CHIP in comments.

Copy link
Contributor

@gerickson gerickson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this looks good; however, the prevailing coding style for method and free function calls is <lower Case><Captial Case><Capital Case>. I'd recommend that we preserve that.

The other option is to transition to the other advocated styles of "a"<Capital Case><Captial Case><Capital Case> for arguments or "i"<Capital Case><Captial Case><Capital Case> for input arguments, "o"<Capital Case><Captial Case><Capital Case> for output arguments, and "io"<Capital Case><Captial Case><Capital Case> for input/output arguments.

@pan-apple
Copy link
Contributor Author

Overall, this looks good; however, the prevailing coding style for method and free function calls is <lower Case><Captial Case><Capital Case>. I'd recommend that we preserve that.

The other option is to transition to the other advocated styles of "a"<Capital Case><Captial Case><Capital Case> for arguments or "i"<Capital Case><Captial Case><Capital Case> for input arguments, "o"<Capital Case><Captial Case><Capital Case> for output arguments, and "io"<Capital Case><Captial Case><Capital Case> for input/output arguments.

@gerickson , I agree with the coding style you mentioned. Are you referring to a specific change in the current PR, as I am unable to spot it? Or, is it a more general comment?

@gerickson
Copy link
Contributor

Overall, this looks good; however, the prevailing coding style for method and free function calls is <lower Case><Captial Case><Capital Case>. I'd recommend that we preserve that.
The other option is to transition to the other advocated styles of "a"<Capital Case><Captial Case><Capital Case> for arguments or "i"<Capital Case><Captial Case><Capital Case> for input arguments, "o"<Capital Case><Captial Case><Capital Case> for output arguments, and "io"<Capital Case><Captial Case><Capital Case> for input/output arguments.

@gerickson , I agree with the coding style you mentioned. Are you referring to a specific change in the current PR, as I am unable to spot it? Or, is it a more general comment?

There were a healthy number of instances of something to the effect of (const char *fooBar, uint8_t chipSomething, Type &dogCow) that are now (const char *fooBar, uint8_t ChipSomething, Type &dogCow) where "Chip" is now antipattern for the argument style.

0x00, 0x00, 0xFE, 0xAF, 0x00, 0x00, 0x10, 0x00, 0x80, 0x00, 0x00, 0x80, 0x5F, 0x9B, 0x34,
0xFB } };

bool UUIDsMatch(const chipBleUUID * idOne, const chipBleUUID * idTwo)
bool UUIDsMatch(const ChipBleUUID * idOne, const ChipBleUUID * idTwo)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

@pan-apple pan-apple Mar 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gerickson chipBleUUID is the data type, not the parameter. I think it used to be WeaveBleUUID

Copy link
Contributor

@gerickson gerickson Mar 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked too quickly, so it is.

}

return err;
}

bool BleLayer::HandleWriteReceived(BLE_CONNECTION_OBJECT connObj, const chipBleUUID * svcId, const chipBleUUID * charId,
bool BleLayer::HandleWriteReceived(BLE_CONNECTION_OBJECT connObj, const ChipBleUUID * svcId, const ChipBleUUID * charId,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gerickson
Copy link
Contributor

Overall, this looks good; however, the prevailing coding style for method and free function calls is <lower Case><Captial Case><Capital Case>. I'd recommend that we preserve that.
The other option is to transition to the other advocated styles of "a"<Capital Case><Captial Case><Capital Case> for arguments or "i"<Capital Case><Captial Case><Capital Case> for input arguments, "o"<Capital Case><Captial Case><Capital Case> for output arguments, and "io"<Capital Case><Captial Case><Capital Case> for input/output arguments.

@gerickson , I agree with the coding style you mentioned. Are you referring to a specific change in the current PR, as I am unable to spot it? Or, is it a more general comment?

There were a healthy number of instances of something to the effect of (const char *fooBar, uint8_t chipSomething, Type &dogCow) that are now (const char *fooBar, uint8_t ChipSomething, Type &dogCow) where "Chip" is now antipattern for the argument style.

I flagged a few of them for reference.

@gerickson
Copy link
Contributor

Overall, this looks good; however, the prevailing coding style for method and free function calls is <lower Case><Captial Case><Capital Case>. I'd recommend that we preserve that.
The other option is to transition to the other advocated styles of "a"<Capital Case><Captial Case><Capital Case> for arguments or "i"<Capital Case><Captial Case><Capital Case> for input arguments, "o"<Capital Case><Captial Case><Capital Case> for output arguments, and "io"<Capital Case><Captial Case><Capital Case> for input/output arguments.

@gerickson , I agree with the coding style you mentioned. Are you referring to a specific change in the current PR, as I am unable to spot it? Or, is it a more general comment?

There were a healthy number of instances of something to the effect of (const char *fooBar, uint8_t chipSomething, Type &dogCow) that are now (const char *fooBar, uint8_t ChipSomething, Type &dogCow) where "Chip" is now antipattern for the argument style.

I flagged a few of them for reference.

My apologies; I scanned through too quickly.

@pan-apple
Copy link
Contributor Author

Overall, this looks good; however, the prevailing coding style for method and free function calls is <lower Case><Captial Case><Capital Case>. I'd recommend that we preserve that.
The other option is to transition to the other advocated styles of "a"<Capital Case><Captial Case><Capital Case> for arguments or "i"<Capital Case><Captial Case><Capital Case> for input arguments, "o"<Capital Case><Captial Case><Capital Case> for output arguments, and "io"<Capital Case><Captial Case><Capital Case> for input/output arguments.

@gerickson , I agree with the coding style you mentioned. Are you referring to a specific change in the current PR, as I am unable to spot it? Or, is it a more general comment?

There were a healthy number of instances of something to the effect of (const char *fooBar, uint8_t chipSomething, Type &dogCow) that are now (const char *fooBar, uint8_t ChipSomething, Type &dogCow) where "Chip" is now antipattern for the argument style.

I flagged a few of them for reference.

My apologies; I scanned through too quickly.

No worries. Thank you for reviewing it!

@woody-apple
Copy link
Contributor

@hawk248 @BroderickCarlin ?

Copy link

@hawk248 hawk248 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@woody-apple woody-apple merged commit b2436cc into project-chip:master Mar 23, 2020
fkjagodzinski pushed a commit to fkjagodzinski/connectedhomeip that referenced this pull request Mar 2, 2021
Switch to use Mbed OS 6.7.0 in chip-build-mbed-os image.
lpbeliveau-silabs pushed a commit to lpbeliveau-silabs/connectedhomeip that referenced this pull request Sep 12, 2022
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
mkardous-silabs referenced this pull request in SiliconLabs/watt-sandbox Oct 6, 2022
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
nipatel-silabs pushed a commit to nipatel-silabs/connectedhomeip that referenced this pull request Oct 19, 2022
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
mkardous-silabs referenced this pull request in mkardous-silabs/connectedhomeip Oct 24, 2022
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
mkardous-silabs referenced this pull request in mkardous-silabs/connectedhomeip Nov 2, 2022
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
shgutte pushed a commit to shgutte/connectedhomeip that referenced this pull request Oct 5, 2023
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
shgutte pushed a commit to shgutte/connectedhomeip that referenced this pull request Jan 11, 2024
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
mykrupp pushed a commit to mykrupp/connectedhomeip that referenced this pull request Jul 18, 2024
Merge in WMN_TOOLS/matter from remove_openthread_ci_scripts to silabs

Squashed commit of the following:

commit 17a94f1e8eb2560a10d7eee409582596b48d72a6
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 14:31:47 2022 -0400

    fix typo

commit 9a44fa8cba80bada7c35673427032b6ebea18f8d
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 12:00:47 2022 -0400

    Fix stash

commit 0362349ec838c52b43a5d26fe208018bf750535b
Author: Yulina Shu <Yulina.Shu@silabs.com>
Date:   Wed Sep 7 23:47:57 2022 +0000

    use build-farm-large for big job

commit c5660b1a3d78f1e71b8d517682ee4137ed5e9221
Author: jepenven-silabs <jean-francois.penven@silabs.com>
Date:   Thu Sep 8 08:33:15 2022 -0400

    Remove OpenThread python scripts build
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants