Swap and correct the documentation of isSpace() and isWhitespace() #595

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

Jump to bottom

Merged

robsoncouto merged 1 commit into arduino:master from per1234:swap-isspace-iswhitespace-documentation

May 17, 2019

Merged

Swap and correct the documentation of isSpace() and isWhitespace() #595

robsoncouto merged 1 commit into arduino:master from per1234:swap-isspace-iswhitespace-documentation

May 17, 2019

Conversation

per1234

Copy link

Collaborator

@per1234 per1234 commented May 7, 2019

Although the documentation previously matched what you might expect these functions to do based on their names, the actual behavior of the functions is the reverse. In addition to this, isWhitespace() matches on horizontal tab as well as space, which was not mentioned in the isSpace() documentation. The decision was made to leave the long established implementation of the functions as-is to avoid causing breakage and to instead correct the documentation to match the actual behavior of the functions.

References:

Swap definitions of isWhitespace and isSpace ArduinoCore-API#27 (see demonstration sketch for proof of function behavior).
Official decision to correct documentation rather than changing the behavior of the functions: Swap definitions of isWhitespace and isSpace ArduinoCore-API#27 (comment)
https://github.com/arduino/ArduinoCore-API/blob/e1eb8de126786b7701b211332dda3f09aa400f35/api/WCharacter.h#L68-L72
https://github.com/arduino/ArduinoCore-API/blob/e1eb8de126786b7701b211332dda3f09aa400f35/api/WCharacter.h#L118-L124

Fixes arduino/Arduino#7041

@per1234


 Swap and correct the documentation of isSpace() and isWhitespace()

2378d87

Although the documentation previously matched what you might expect these functions to do based on their names, the actual behavior of the functions is the reverse. In addition to this, isWhitespace() matches on horizontal tab as well as space, which was not mentioned in the isSpace() documentation. The decision was made to leave the implementation of the functions as-is to avoid causing breakage and to correct the documentation to match the actual behavior of the functions.
More information:
arduino/ArduinoCore-API#27