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] Writing a new Arduino documentation about GPIO #5894

Merged
merged 16 commits into from
Dec 14, 2021

Conversation

halyssonJr
Copy link
Contributor

@halyssonJr halyssonJr commented Nov 16, 2021


Checklist

  1. Created five sections (About, GPIO Configuration, API, Simulation and Exemple Code)
  2. Created simulation application

Summary

Arduino Documentation for GPIO

Impact

None

Co-authored-by: Pedro Minatel pminatel@gmail.com

@CLAassistant
Copy link

CLAassistant commented Nov 16, 2021

CLA assistant check
All committers have signed the CLA.

@halyssonJr halyssonJr closed this Nov 16, 2021
@halyssonJr halyssonJr reopened this Nov 16, 2021
@pedrominatel
Copy link
Member

@halyssonJr first things first, remove the build folder. I'll check why the .gitignore is still considering the _build folder when adding the files.

docs/source/api/gpio.rst Outdated Show resolved Hide resolved
docs/source/api/gpio.rst Outdated Show resolved Hide resolved
@pedrominatel
Copy link
Member

@halyssonJr please be aware of not adding the unrelated folders and files of your build and environment to the commit. Add only the files that you are working on.

Can you clarify why you've changed the docs/source/conf.py file?

@halyssonJr
Copy link
Contributor Author

halyssonJr commented Nov 16, 2021

@pedrominatel, maybe i just have uncommented, but not made any changes directly to the docs/source/conf.py file

docs/source/api/gpio.rst Outdated Show resolved Hide resolved
Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

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

PTAL at my considerations.

docs/source/api/gpio.rst Outdated Show resolved Hide resolved
docs/source/api/gpio.rst Show resolved Hide resolved
@halyssonJr
Copy link
Contributor Author

@pedrominatelI, I try to split my commit. So I can't upload just the files I changed. In the next PR I will fix these problems

@VojtechBartoska VojtechBartoska added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Nov 18, 2021
@pedrominatel
Copy link
Member

pedrominatel commented Nov 22, 2021

@halyssonJr your PR is messed. You suppose to edit only one file but now you have added 191!

If you need help to understand the Git flow I'll be glad to help. Currently, your PR is not following the expectations and cant be reviewed. Ping me later if you need help.

@pedrominatel pedrominatel marked this pull request as draft November 22, 2021 12:53
@pedrominatel pedrominatel marked this pull request as ready for review December 13, 2021 12:49
@pedrominatel pedrominatel self-requested a review December 13, 2021 13:01
@pedrominatel
Copy link
Member

@halyssonJr please take a look at my modifications.

@pedrominatel pedrominatel dismissed stale reviews from VojtechBartoska and themself December 13, 2021 13:24

New version available.

Copy link
Contributor

@VojtechBartoska VojtechBartoska left a comment

Choose a reason for hiding this comment

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

Overall looks good. Found only one small typo.

docs/source/api/gpio.rst Outdated Show resolved Hide resolved
@pedrominatel pedrominatel removed their request for review December 13, 2021 15:12
@me-no-dev me-no-dev merged commit fb00b51 into espressif:master Dec 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants