[MCXA] i2c: improve documentation#5654
Merged
felipebalbi merged 2 commits intoembassy-rs:mainfrom Mar 12, 2026
Merged
Conversation
Contributor
Author
|
Glad to modify, remove, update anything here. |
jamesmunns
reviewed
Mar 12, 2026
Contributor
|
I mean it looks fine. But these types of docs go out of date fast usually |
Contributor
Author
Was the original better? I can remove the changes to the public interface, keep the module-level update and all the ones that make sure doc code blocks compile. |
felipebalbi
force-pushed
the
mcxa/i2c-docs
branch
from
bd32b1f to
dd2cc31
Compare
Contributor
Author
|
I'm queueing this one. If it turns out we have "too much" information on the public methods, we can always delete the extra docs later. Meanwhile, all rustdoc examples compile fine. |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Make the documentation a little more extensive, if repetitive at times.
felipebalbi
force-pushed
the
mcxa/i2c-docs
branch
from
dd2cc31 to
013bb40
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Make the documentation a little more extensive, if repetitive at times.