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

Correct documentation on ModbusServer::poll() #136

Merged
merged 1 commit into from
Feb 19, 2024

Conversation

SimonFJ20
Copy link
Contributor

@SimonFJ20 SimonFJ20 commented Jan 4, 2024

The ModbusServer::poll()1 function returns an int, in the docs it said it returned nothing (void). I have changed the API-documetation to match the actual function declaration and doc-comment.

I observed this on the Arduino website.2 I have archived the Reference page with the mistake on Wayback Machine for future reference.3

I don't know if i have made the change in the correct file, but the mistake was the same in it, so I assume it supplies the information for the website.

In case my assumption is true: may i ask why the documentation on the website isn't auto-generated from the doc-comments in the code files?

@SimonFJ20 SimonFJ20 changed the title Correct return value documentation Correct return value documentation on ModbusServer::pol() Jan 4, 2024
@SimonFJ20 SimonFJ20 changed the title Correct return value documentation on ModbusServer::pol() Correct documentation on ModbusServer::pol() Jan 4, 2024
@SimonFJ20 SimonFJ20 changed the title Correct documentation on ModbusServer::pol() Correct documentation on ModbusServer::poll() Jan 4, 2024
@CLAassistant
Copy link

CLAassistant commented Jan 4, 2024

CLA assistant check
All committers have signed the CLA.

@PanzerFowst
Copy link

Would it be too much to also add to this ticket a little more explanation on the poll() method such as whether it is blocking?

@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Jan 10, 2024
@aentinger
Copy link
Contributor

Would it be too much to also add to this ticket a little more explanation on the poll() method such as whether it is blocking?

More documentation would always be better, but at least this is a small fix and the OP seems to have not reacted on your feedback. I'll go ahead and merge this but I'll be happy accepting further pull requests with more detailed documentation enhancements.

@aentinger aentinger merged commit f60d20d into arduino-libraries:master Feb 19, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants