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

docs: document capnrpc/src/lib.rs #502

Merged
merged 1 commit into from
May 27, 2024
Merged

Conversation

SteveLauC
Copy link
Contributor

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.

Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 51.73%. Comparing base (ab342b3) to head (8c86956).
Report is 15 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #502      +/-   ##
==========================================
+ Coverage   51.64%   51.73%   +0.09%     
==========================================
  Files          69       69              
  Lines       33735    33808      +73     
==========================================
+ Hits        17422    17492      +70     
- Misses      16313    16316       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dwrensha dwrensha merged commit 9a482bf into capnproto:master May 27, 2024
10 checks passed
@dwrensha
Copy link
Member

Thanks!

@SteveLauC SteveLauC deleted the docs/lib branch May 27, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants