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

Docs incorrect for LMS_Calibrate #364

Open
srcejon opened this issue Aug 21, 2022 · 0 comments
Open

Docs incorrect for LMS_Calibrate #364

srcejon opened this issue Aug 21, 2022 · 0 comments

Comments

@srcejon
Copy link

srcejon commented Aug 21, 2022

The docs for LMS_Calibrate says:

* @return  0 on success, (-1) on failure

However, in LMS7002M::CalibrateTx, and elsewhere, errnos are returned as the error values:

 return ReportError(EINVAL, "Tx Calibration: MCU error %i (%s)", status, MCU_BD::MCUStatusMessage(status));

So LMS_Calibrate can return EINVAL on error.

Doc should probably be something like:

* @return  0 on success, (-1 or errno) on failure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant