Skip to content

Missing documentation of constructor parameters #2999

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
radio-miskovice opened this issue Mar 16, 2025 · 0 comments
Open

Missing documentation of constructor parameters #2999

radio-miskovice opened this issue Mar 16, 2025 · 0 comments

Comments

@radio-miskovice
Copy link

📚 Documentation

There is no API reference, e.g. list of all constructor parameters, their values, etc.

Especially in this regard there is nothing about RTS/CTS, DTR/DSR signals which can affect hardware behavior and must be controlled by the application.

Have you read the Contributing Guidelines on docs?

Yes, I did. It contains lots of unrelated stuff but nothing to the topic "hardware signals". In general my impression is that instead of serial port this package deals with a number of things not specific to serial port, which should rather be handled by stream packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant