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.

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

Preferences documentation error - getBool call definition displays getUChar. #9887

Closed
1 task done
paulgiordano opened this issue Jun 18, 2024 · 1 comment · Fixed by #9901
Closed
1 task done

Preferences documentation error - getBool call definition displays getUChar. #9887

paulgiordano opened this issue Jun 18, 2024 · 1 comment · Fixed by #9901
Assignees
@P-R-O-C-H-Y
Labels
Status: In Progress Issue is in progress Type: Documentation Issue pertains to Documentation of Arduino ESP32
Milestone
3.0.2

Comments

@paulgiordano
Copy link

Board

Any

Device Description

Any

Hardware Configuration

n/a

Version

latest master (checkout manually)

IDE Name

VSCode/PlatformIO

Operating System

Ubuntu 22.04

Flash frequency

n/a

PSRAM enabled

yes

Upload speed

115200

Description

The entry in docs/en/api/preferences.rst, getUChar should read getBool:

getBool

Retrieve a value stored against a given key in the currently open namespace.

uint8_t getUChar(const char* key, uint8_t defaultValue = 0);

Except for the data type returned, behaves exactly like getChar.

Sketch

n/a

Debug Message

n/a

Other Steps to Reproduce

No response

I have checked existing issues, online documentation and the Troubleshooting Guide

  • I confirm I have checked existing issues, online documentation and Troubleshooting guide.
@paulgiordano paulgiordano added the Status: Awaiting triage Issue is waiting for triage label Jun 18, 2024
@lbernstone
Copy link
Contributor

https://docs.espressif.com/projects/arduino-esp32/en/latest/api/preferences.html#getbool

@P-R-O-C-H-Y P-R-O-C-H-Y mentioned this issue Jun 19, 2024
Merged
@P-R-O-C-H-Y P-R-O-C-H-Y added Type: Documentation Issue pertains to Documentation of Arduino ESP32 and removed Status: Awaiting triage Issue is waiting for triage labels Jun 19, 2024
@VojtechBartoska VojtechBartoska added the Status: In Progress Issue is in progress label Jun 19, 2024
@VojtechBartoska VojtechBartoska added this to the 3.0.2 milestone Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@P-R-O-C-H-Y P-R-O-C-H-Y

Labels
Status: In Progress Issue is in progress Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Milestone
3.0.2
Development

Successfully merging a pull request may close this issue.

docs(preferences): Fix getBool function P-R-O-C-H-Y/arduino-esp32
4 participants
@paulgiordano @lbernstone @VojtechBartoska @P-R-O-C-H-Y