reference-en icon indicating copy to clipboard operation
reference-en copied to clipboard

Published 20 hours ago • verified publisher icon arduino

Update bitWrite.adoc

Open HowardWParr opened this issue 3 years ago • 4 comments

The bitWrite() function does return the updated value.

HowardWParr avatar Jun 12 '22 22:06 HowardWParr

If "it is indisputable that the "return" of the macro must be documented correctly" then document it correctly. I bring this to your attention as there are similar functions with this usage documented. Consistency is a hallmark of good documentation.

Howard

HowardWParr avatar Aug 13 '22 20:08 HowardWParr

Clearly we are in agreement on this subject, so there is no need to discuss it further. Let's focus on the specifics of my review so we can make progress in that direction.

per1234 avatar Aug 13 '22 20:08 per1234

The specifics of your review were not very clear. However, if the "Returns" section of the documentation is updated from "Nothing" to indicate that there is in fact a return from this function, then that's all I'm looking for..

HowardWParr avatar Aug 13 '22 21:08 HowardWParr

@HowardWParr if you agree with the change I requested during my review, then make that change.

If you disagree with the change I requested, then provide a clear explanation of why you disagree.

I notice that you are replying via email. Please come here to the pull request page on GitHub so that you can be sure to see the actual suggestion I made. The pull request is at this URL:

https://github.com/arduino/reference-en/pull/885

per1234 avatar Aug 13 '22 21:08 per1234