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.

Sign up for GitHub

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

Jump to bottom

setDelays() is undocumented #45

Open
PanzerFowst opened this issue Jan 5, 2024 · 4 comments
Open

setDelays() is undocumented #45

PanzerFowst opened this issue Jan 5, 2024 · 4 comments
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project

Comments

@PanzerFowst
Copy link

PanzerFowst commented Jan 5, 2024 •
edited

The library's public API includes a setDelays function:

ArduinoRS485/src/RS485.h

Line 83 in 9d5872e

void setDelays(int predelay, int postdelay);

But this function is not mentioned in the documentation (Arduino library documentation).

The entire public API of the library must be documented.

An example sketch should be provided that demonstrates its usage, including whether it must be called before a begin() call, after, or does it not matter?
@per1234 per1234 changed the title Missing SetDelay() documentation setDelays() is undocumented Jan 5, 2024
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Jan 5, 2024
@JojoS62

This comment was marked as off-topic.

Sign in to view
@PanzerFowst

This comment was marked as off-topic.

Sign in to view
@per1234

This comment was marked as resolved.

Sign in to view
@JojoS62

This comment was marked as off-topic.

Sign in to view
@arduino-libraries arduino-libraries locked as too heated and limited conversation to collaborators Feb 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JojoS62 @per1234 @PanzerFowst