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: correct Float type size in Preferences API and Tutorial documentation #10113

Merged
merged 4 commits into from
Aug 13, 2024

Conversation

Xylopyrographer
Copy link
Contributor

Description of Change

Correct the size of the Preferences Float type in the API and Tutorial documentation

Tests scenarios

Verified by running a sketch that returns the sizeof() a float_t and a float variable.

Related links

None

Correct in the data type table and the API call the size of the Preferences `Float` type and returned value for `putFloat()`.
Correct Float type size in the Preferences Types table.
Revise text to use `float_t` in place of `float`.
Copy link
Contributor

github-actions bot commented Aug 5, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Correct Float type size":
    • summary looks empty
    • type/action looks empty
  • the commit message "Correct Float type size":
    • body's lines must not be longer than 100 characters
    • summary looks empty
    • type/action looks empty
  • the commit message "Correct doc build error":
    • summary looks empty
    • type/action looks empty
  • the commit message "Update Float call prototype":
    • 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).

Messages
📖 You might consider squashing your 4 commits (simplifying branch history).

👋 Hello Xylopyrographer, 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 1294237

@P-R-O-C-H-Y P-R-O-C-H-Y added Type: Documentation Issue pertains to Documentation of Arduino ESP32 Area: Libraries Issue is related to Library support. labels Aug 5, 2024
@P-R-O-C-H-Y
Copy link
Member

Correct the `Explicit markup ends without a blank line; unexpected unindent.`
@P-R-O-C-H-Y P-R-O-C-H-Y added the Status: Pending Merge Pull Request is ready to be merged label Aug 6, 2024
@me-no-dev me-no-dev merged commit f1df088 into espressif:master Aug 13, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Libraries Issue is related to Library support. Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants