Make `File::rewindDirectory` reference demo code more clear - Githubissues

arduino-libraries / SD

SD Library for Arduino

http://arduino.cc/

GNU General Public License v3.0

179 stars 155 forks source link

Make `File::rewindDirectory` reference demo code more clear #118

Closed per1234 closed 2 years ago

per1234 commented 2 years ago

The reference page for File::rewindDirectory provides a sketch demonstrating its usage.

Feedback was received that the code did not clearly demonstrate the use and effect of the function: https://github.com/arduino/Arduino/issues/11734

@PaulStoffregen suggested several changes to improve on that situation. An atomic subset of those are proposed here:

Avoid unnecessary calls of File::rewindDirectory: https://github.com/arduino-libraries/SD/commit/615568f44e89b1bc7c4b330b736921aef8f159d6
Print the card file structure twice: https://github.com/arduino-libraries/SD/commit/55cd20fec7f169e63f6323845d4916d5d923d79f

Resolves (partially) https://github.com/arduino/Arduino/issues/11734