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

Document message response codes in request datatypes #2

Open
adrianghc opened this issue Jun 6, 2021 · 0 comments
Open

Document message response codes in request datatypes #2

adrianghc opened this issue Jun 6, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@adrianghc
Copy link
Owner

adrianghc commented Jun 6, 2021

Currently, message response codes are not documented in the request datatypes in the include/hems/messages headers, but instead as return values for the handler functions for these request messages. This is a very flawed approach from an API documentation standpoint, as a developer wanting to send a message to a module currently needs to look in two places in the code: One to learn the format of the message and a separate place to learn the possible responses. Instead, possible message response codes need to be documented (additionally or exclusively) in the request datatype declarations.

@adrianghc adrianghc added the documentation Improvements or additions to documentation label Jun 6, 2021
@adrianghc adrianghc self-assigned this Jun 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant