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

Reference of Serial.availableForWrite() does not state what returned value is nor where to find out. #855

Open
brewmanz opened this issue Nov 14, 2021 · 1 comment
Labels

Comments

@brewmanz
Copy link
Contributor

brewmanz commented Nov 14, 2021

https://www.arduino.cc/reference/en/language/functions/communication/serial/availableforwrite/ does not tell the user about the returned value:

  • What its datatype is (signed or not, whether 8 or 16 or ... bits)
  • Where to find out this information

I want to check that there is enough space for non-blocking writes; and so what type/size of variable do I need to use?
For i have an Arduino chip of very little brain, and long words or other datatypes bother me^.
Yes, I've since discovered that it's an int, but why not just tell people without making them search the source?

^ Apologies to A. A. Milne

@per1234
Copy link
Collaborator

per1234 commented Nov 14, 2021

This is a small piece of the big picture, which is that the essential documentation of parameter and return types is missing or incorrect throughout much of the reference: #15

@per1234 per1234 added the bug label Nov 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants