mctp: Adjust doc comments #18
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
nnethercote
force-pushed
the
mctp-api-docs
branch
from
32b130a to
37a7863
Compare
mkj
reviewed
Jul 30, 2025
Member
mkj
left a comment
mkj
left a comment
There was a problem hiding this comment.
One small thing - for commits only touching one crate could you give it a mctp: commit prefix etc? That makes scanning a bit easier for collating changelogs etc.
| /// The sent message type will match that received by the | ||
| /// corresponding `AsyncListener`. | ||
| /// | ||
| /// The `integrity_check` argument is the MCTP header IC bit. |
Member
There was a problem hiding this comment.
I think we still might want something like
/// Equivalent of [`ReqChannel::send_vectored`]
Otherwise docs for traits that implement it won't have any link to ReqChannel, for example RouterAsyncReqChannel.
nnethercote
force-pushed
the
mctp-api-docs
branch
from
37a7863 to
df72cfb
Compare
- Make the doc comments on the methods of the async types consistently refer to the methods of the sync types, and remove the `allow(missing_docs)`. - Clarify the comments about the return type on the `recv` methods, to better explain what happens with `buf`, and to get the tuple ordering right. Signed-off-by: Nicholas Nethercote <[email protected]>
nnethercote
force-pushed
the
mctp-api-docs
branch
from
df72cfb to
f4056aa
Compare
Contributor
Author
|
I have updated the async docs to consistently point to the equivalent sync docs. (The aim here was consistency rather than any particular form.) |
Member
|
Thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 doc comments on the methods of the async types consistently refer to the methods of the sync types, and remove the
allow(missing_docs).Clarify the comments about the return type on the
recvmethods, to better explain what happens withbuf, and to get the tuple ordering right.