Skip to content

[Documentation] ArduinoModbus Server, wrong return value for configure* functions #10795

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

Open
wayofka opened this issue Sep 25, 2020 · 2 comments
Assignees
Labels
Component: Documentation Related to Arduino's documentation content Library: Other Arduino libraries that don't have their own label Type: Bug

Comments

@wayofka
Copy link

wayofka commented Sep 25, 2020

In documentation for ArduinoModbus library, all configure function for Server have wrong return value in documentation.
For example https://www.arduino.cc/en/ArduinoModbus/ModbusServerconfigureDiscreteInputs
The function allocate memory for Moddus registers and coils.

Returns
0 on success, 1 on failure 

Return should be ( according to source code )
-1 Invalid argument
0 on failure
1 on success

Same for all configure function

@per1234 per1234 added Component: Documentation Related to Arduino's documentation content Type: Bug Library: Other Arduino libraries that don't have their own label labels Sep 25, 2020
@prath06
Copy link

prath06 commented Nov 2, 2020

I want to contribute on this.

@per1234
Copy link
Collaborator

per1234 commented Nov 2, 2020

@prath06 I appreciate your interest in contributing to the Arduino project. Unfortunately, the documentation content is not hosted in a public repository, so it will not be possible for you to assist with this.

The same goes for the other issue you commented on (#10800 (comment)).

I'm sure you will find many other opportunities to contribute to the Arduino open source community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Related to Arduino's documentation content Library: Other Arduino libraries that don't have their own label Type: Bug
Projects
None yet
Development

No branches or pull requests

4 participants