chore: Update API documentation #151
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chore: improve i2c error messages
Contributor
There was a problem hiding this comment.
Pull Request Overview
Improves I2C error messages to provide clearer context and direction, while updating documentation for the NoteI2c and NoteSerial classes. The changes standardize error message formatting and enhance API documentation clarity.
- Standardized I2C error message format with direction indicators (rx/tx) and consistent tag placement
- Renamed test functions to better reflect their purpose with simplified naming
- Updated documentation comments to be more descriptive and provide clearer implementation guidance
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| test/NoteI2c_Arduino.test.cpp | Updated test expectations to match new error message format and renamed test functions |
| src/NoteSerial.hpp | Enhanced documentation comments for better API clarity |
| src/NoteI2c_Arduino.cpp | Implemented new error message format and improved transmission error handling |
| src/NoteI2c.hpp | Expanded documentation with detailed parameter descriptions and implementation guidance |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
chore: improve i2c error messages