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

Added isKey and getType methods to Preferences documentation #9111

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Added isKey and getType methods to Preferences documentation #9111

merged 1 commit into from
Jan 16, 2024

Conversation

Viproz
Copy link
Contributor

@Viproz Viproz commented Jan 15, 2024

Description of Change

Addition of documentation for the functions isKey and getType for the Preferences libraries.
These functions were added here #4441 but not documented.

Tests scenarios

I have not tested, no code change only a change in the rst file

Related links

Documents PR #4441
Adds documentation for issue #4440

@CLAassistant
Copy link

CLAassistant commented Jan 15, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Added isKey and getType methods to the documentation":
    • 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 Viproz, 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 6635b46

@me-no-dev
Copy link
Member

Thanks @Viproz !

@me-no-dev me-no-dev merged commit da6325d into espressif:master Jan 16, 2024
40 checks passed
@Xylopyrographer
Copy link
Contributor

When the Preferences API and Tutorial docs were released under #6442, it included details on getType, which can be seen here as well: https://espressif-docs.readthedocs-hosted.com/projects/arduino-esp32/en/latest/api/preferences.html

So I understand, wondering how getType went missing in the doc?

@Viproz
Copy link
Contributor Author

Viproz commented Jan 17, 2024

My bad sorry, getType is written twice in my version, only isKey needed to be added, do you want me to submit a new PR with the second getType removed?

@Xylopyrographer
Copy link
Contributor

@Viproz That would be great. 👍

Would you also be able to submit a new PR with that correction to the release/v2.x branch so it gets back ported to the pending 2.0.15 release?

Not sure how isKey got missed in the API doc as a use case is presented in the Preferences tutorial. Nice catch 😄.

@Viproz Viproz deleted the patch-1 branch January 19, 2024 11:01
me-no-dev pushed a commit that referenced this pull request Jan 19, 2024
* Added isKey and getType methods to the documentation (#9111)

* Removed duplicated getType documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants