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(ble): Fixed typos (or copy/paste issues) in comments for AD types in BLEAdvertising #10512

Merged

Conversation

thomasw-mitutoyo-ctl
Copy link
Contributor

Fix #10511

Description of Change

Changes in comments only. You should see all AD type codes in the surrounding code provided by the diff.
Impact: improve readability and understanding of the code for future readers (like myself)

Tests scenarios

None. This is just related to reading of the source code.

Related links

Closes #10511
#10511

@CLAassistant
Copy link

CLAassistant commented Oct 23, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Oct 23, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Fix comments for AD types in advertising":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello thomasw-mitutoyo-ctl, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against e38a696

@thomasw-mitutoyo-ctl thomasw-mitutoyo-ctl changed the title Fix typos (or copy/paste issues) in comments for AD types in BLEAdvertising fix(ble); Fixed typos (or copy/paste issues) in comments for AD types in BLEAdvertising Oct 23, 2024
@thomasw-mitutoyo-ctl thomasw-mitutoyo-ctl changed the title fix(ble); Fixed typos (or copy/paste issues) in comments for AD types in BLEAdvertising fix(ble): Fixed typos (or copy/paste issues) in comments for AD types in BLEAdvertising Oct 23, 2024
@SuGlider SuGlider self-requested a review October 23, 2024 14:23
@SuGlider SuGlider self-assigned this Oct 23, 2024
@SuGlider SuGlider added the Area: BLE Issues related to BLE label Oct 23, 2024
@SuGlider SuGlider added this to the 3.1.0-RC2 milestone Oct 23, 2024
@SuGlider
Copy link
Collaborator

Target to master - 3.0.8 and 3.1.0-RC2

Copy link
Contributor

github-actions bot commented Oct 23, 2024

Test Results

0 tests   0 ✅  0s ⏱️
0 suites  0 💤
0 files    0 ❌

Results for commit e38a696.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@SuGlider SuGlider left a comment

Choose a reason for hiding this comment

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

LGTM. thank you @thomasw-mitutoyo-ctl for the PR.

Copy link
Contributor

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32S3000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32H2000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
BLE/examples/BLE5_extended_scan00000000--
BLE/examples/BLE5_multi_advertising00000000--
BLE/examples/BLE5_periodic_advertising00000000--
BLE/examples/BLE5_periodic_sync00000000--
BLE/examples/Beacon_Scanner0000000000
BLE/examples/Client0000000000
BLE/examples/EddystoneTLM_Beacon0000000000
BLE/examples/EddystoneURL_Beacon0000000000
BLE/examples/Notify0000000000
BLE/examples/Scan0000000000
BLE/examples/Server0000000000
BLE/examples/Server_multiconnect0000000000
BLE/examples/UART0000000000
BLE/examples/Write0000000000
BLE/examples/iBeacon0000000000

@SuGlider SuGlider added the Status: Review needed Issue or PR is awaiting review label Oct 23, 2024
@me-no-dev me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Oct 23, 2024
@me-no-dev me-no-dev merged commit cb83cda into espressif:master Oct 23, 2024
84 of 98 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: BLE Issues related to BLE Status: Pending Merge Pull Request is ready to be merged
Projects
Development

Successfully merging this pull request may close these issues.

Comments in BLEAdvertising are wrong/misleading
4 participants