Skip to content

Adding WiFiS3 API documentation #415

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

Merged
merged 32 commits into from
Mar 13, 2025
Merged

Conversation

BenjaminDannegard
Copy link
Contributor

@BenjaminDannegard BenjaminDannegard commented Dec 16, 2024

Added documentation for the WiFiS3 library to the library files and added a API.h file

@CLAassistant
Copy link

CLAassistant commented Dec 16, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ BenjaminDannegard
✅ sebromero
❌ actions-user
You have signed the CLA already but the status is still pending? Let us recheck it.

@BenjaminDannegard BenjaminDannegard changed the title Updating fork Adding WiFiS3 API documentation Dec 16, 2024
@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Dec 16, 2024
@pennam
Copy link
Contributor

pennam commented Feb 13, 2025

@BenjaminDannegard what is the status of this PR?

@BenjaminDannegard
Copy link
Contributor Author

@BenjaminDannegard what is the status of this PR?

I am trying to fix the issues so that we can merge

@sebromero
Copy link
Contributor

@BenjaminDannegard I suggest you remove the render-documentation.yml workflow from this PR and create a separate one only with that file. That will allow to merge the API docs and trouble shoot the workflow error.

@pennam
Copy link
Contributor

pennam commented Feb 28, 2025

@BenjaminDannegard ci is failing for reasons not relates to this PR, so you don't have to worrie about the ❌ for C33

You need to sign the CLA to get this PR merged

@BenjaminDannegard
Copy link
Contributor Author

BenjaminDannegard commented Feb 28, 2025

@BenjaminDannegard ci is failing for reasons not relates to this PR, so you don't have to worrie about the ❌ for C33

You need to sign the CLA to get this PR merged

@pennam I have signed it now, but it is still showing that "❌ actions-user" has not signed. Not sure what this means

Copy link
Collaborator

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

I have submitted a pull request to the "arduino/render-docs-github-action" action that generated the commit by "actions-user" to attribute commits to a more appropriate entity, which will not fail the CLA check:

arduino/render-docs-github-action#1

My recommendation is that the failing CLA check not be treated as a blocker for merging the pull request. The repository admins can bypass the required check to merge the PR.

If arduino/render-docs-github-action#1 is rejected then we can set up a CLA exemption for the "actions-user" account to avoid CLA check failures for future PRs that contain commits generated by the "arduino/render-docs-github-action" action.

@sebromero
Copy link
Contributor

@per1234 You're admin of this repo. Can you please merge the PR?

@per1234
Copy link
Collaborator

per1234 commented Mar 13, 2025

@sebromero I would only feel comfortable merging this after I had done a comprehensive review. I am not very knowledgeable in this code base so I'm not well equipped to perform such a review.

@sebromero sebromero merged commit 84d44b8 into arduino:main Mar 13, 2025
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants