Adafruit_PWMServoDriver::setPWM returns 0 not endTransmission response

[Carl-UB]

Using ESP32 and VSCode with PlatformIO, but this issue doesn't relate to any particular board/IDE.

Adafruit_PWMServoDriver::setPWM documentation states that it returns the result from endTransmission, but in fact always returns 0.

Adafruit-PWM-Servo-Driver-Library/Adafruit_PWMServoDriver.cpp

Line 231 in 032e425

* @return result from endTransmission

vs.

Adafruit-PWM-Servo-Driver-Library/Adafruit_PWMServoDriver.cpp

Line 252 in 032e425

return 0;

It would be good if either the documentation reflected reality, or even better if it actually returned the endTransmission response to allow for detection of errors. This would be similarly useful for Adafruit_PWMServoDriver::writeMicroseconds and Adafruit_PWMServoDriver::setPin.

[caternuson]

Thanks. Looks like the docstring was not updated when the switch to BusIO was done.

[caternuson]

OK, should be fixed with #98.

There are some limitations that prevent fully passing the endTransmission return. But it now returns 0 or 1. And docstring updated to reflect that.

[Carl-UB]

Great, thanks for the speedy fix. Is there a generally preferred choice or rationale between returning a zero code on success vs. a bool indicating success or failure? E.g. Adafruit_PWMServoDriver::begin returns a bool but this returns uint?

[caternuson]

In that case, just to avoid making a breaking change. The return is currently uint8_t. Otherwise would make it a bool.