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.
What does this PR do
Document most types/interfaces in
capnp-rpc/src/lib.rs
.Why
I started working on #495, the first thing was to read the source code, then I found these are a lot of concepts that I am not aware of, and they do not have documents. Considering this is a Rust port is the C++ implementation, authors of this port should be already familiar with those concepts, this is understandable.
But I am completely new to them, so I took a look at the C++ repo, found the concept I wanted to understand, and copied the documents into the Rust code.
For stuff that already exists in the C++ impl, the documents are directly pasted, documents of other things are added based on my understanding.