Skip to content

Add Preferences library API and tutorial documents #6442

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Mar 28, 2022
Merged

Add Preferences library API and tutorial documents #6442

merged 5 commits into from
Mar 28, 2022

Conversation

Xylopyrographer
Copy link
Contributor

Summary

Adds API and tutorial documents for the Preferences library.

Impact

None

@Xylopyrographer
Add Preferences library API and tutorial documents
80e7e1a 
Add API and tutorial documents for the  Preferences library.
@Xylopyrographer
Copy link
Contributor Author

@pedrominatel Since I never seem to get PR's right the first time, could you take a look at this and let me know if I need to do anything else to move this along. Thanks.

@VojtechBartoska VojtechBartoska added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Mar 18, 2022
pedrominatel
pedrominatel reviewed Mar 22, 2022
View reviewed changes
pedrominatel
pedrominatel reviewed Mar 22, 2022
View reviewed changes
pedrominatel
pedrominatel reviewed Mar 22, 2022
View reviewed changes
pedrominatel
pedrominatel reviewed Mar 22, 2022
View reviewed changes
pedrominatel
pedrominatel reviewed Mar 22, 2022
View reviewed changes
pedrominatel
pedrominatel reviewed Mar 22, 2022
View reviewed changes
pedrominatel
pedrominatel reviewed Mar 22, 2022
View reviewed changes
pedrominatel
pedrominatel requested changes Mar 22, 2022
View reviewed changes
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.

Hi @Xylopyrographer.

Thank you for your valuable contribution!
See my comments and consider the changes. If you have any questions, do not hesitate to contact us.

Can you take a look @VojtechBartoska?

@Xylopyrographer
Revise per review
abef939 
Correct some errors. Remove the "wordiness" is a few places.
pedrominatel
pedrominatel approved these changes Mar 23, 2022
View reviewed changes
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.

LGTM

@Xylopyrographer
Copy link
Contributor Author

@pedrominatel
One thing the might need fixing. In the tutorial preferences.rst is a link to the API preferences.rst document. I don't know what the proper syntax is for creating this link so I totally guessed at one.

pedrominatel
pedrominatel reviewed Mar 24, 2022
View reviewed changes
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

VojtechBartoska
VojtechBartoska approved these changes Mar 24, 2022
View reviewed changes
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.

I went through it quickly and it looks good to me. Thanks for your extensive contribution @Xylopyrographer!

@Xylopyrographer
Correct link to Preferences API
9342c50 
Update the references and link to the Preferences API document.
@pedrominatel pedrominatel changed the base branch from master to esp32-s3-support March 25, 2022 16:09
@pedrominatel pedrominatel changed the base branch from esp32-s3-support to master March 25, 2022 16:10
@me-no-dev me-no-dev merged commit 3f79097 into espressif:master Mar 28, 2022
@Sys64736 Sys64736 mentioned this pull request Apr 18, 2022
Closed
1 task
@Xylopyrographer Xylopyrographer mentioned this pull request Jan 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pedrominatel pedrominatel pedrominatel approved these changes

+1 more reviewer

@VojtechBartoska VojtechBartoska VojtechBartoska approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Xylopyrographer @pedrominatel @VojtechBartoska @me-no-dev