Skip to content

Documentation update in preferences.rst : fix return value of getBytes #7981

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

Merged
merged 1 commit into from
Mar 31, 2023
Merged

Documentation update in preferences.rst : fix return value of getBytes #7981

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/api/preferences.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ Copy a series of bytes stored against a given key in the currently open namespac
- the number of bytes to be written to the buffer pointed to by ``buf``

**Returns**
* if successful, the number of bytes equal to ``len`` is written to buffer ``buf``, and the method returns ``1``.
* if successful, the number of bytes equal to ``len`` is written to buffer ``buf``, and the method returns ``len``.
* if the method fails, nothing is written to the buffer and the method returns ``0``.

**Notes**
Expand Down Expand Up @@ -698,4 +698,4 @@ Get the number of free entries available in the key table of the currently open
* A message providing the reason for a failed call is sent to the arduino-esp32 ``log_e`` facility.


.. --- EOF ----
.. --- EOF ----