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

docs(docs/icpm_echo): Added requires libraries to the code example so that it doesn't throw undeclared error (IDFGH-14318) #15110

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

b0tFilip
Copy link

@b0tFilip b0tFilip commented Dec 30, 2024

Added libraries so that the code example doesn't throw errors about undeclared struct and function.
It didn't work because of missing declarations:
struct addrinfo
getaddrinfo()

It's just a small detail but it cost me an hour of debuging to find these libs that fix it.

Added libs so that the code example works.
It didn't work because of missing declarations:
    struct addrinfo 
    getaddrinfo()
@CLAassistant
Copy link

CLAassistant commented Dec 30, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Dec 30, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Added requires libs to the code example":
    • 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 b0tFilip, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for 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 via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

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 synchronize it into our internal git repository.
4. In the internal git repository 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.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 30ff99b

@b0tFilip b0tFilip changed the title Added requires libs to the code example so that it now works docs: Added requires libs to the code example so that it now works Dec 30, 2024
@espressif-bot espressif-bot added the Status: Opened Issue is new label Dec 30, 2024
@github-actions github-actions bot changed the title docs: Added requires libs to the code example so that it now works docs: Added requires libs to the code example so that it now works (IDFGH-14318) Dec 30, 2024
Copy link
Collaborator

@david-cermak david-cermak left a comment

Choose a reason for hiding this comment

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

Thanks for your help and contribution!
could you please address the formal issues with

  • you commit message as mentioned here?
  • make the same changes also the CN docs in docs/zh_CN/api-reference/protocols/icmp_echo.rst?

@b0tFilip b0tFilip changed the title docs: Added requires libs to the code example so that it now works (IDFGH-14318) docs: Added requires libraries to the code example so that it now works (IDFGH-14318) Jan 6, 2025
@b0tFilip b0tFilip changed the title docs: Added requires libraries to the code example so that it now works (IDFGH-14318) docs(docs/icpm_echo): Added requires libraries to the code example so that it doesn't throw undeclared error (IDFGH-14318) Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Opened Issue is new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants