Add docstrings for a few small modules! #286
Merged
Conversation
This file contains 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
3 tasks
jrose-signal
reviewed
May 4, 2021
|
Thanks for working on this! GitHub is showing a warning about the email you've used for these commits: |
|
@Be-ing thanks! I have fixed the issue. |
cosmicexplorer
force-pushed
the
docs-1
branch
2 times, most recently
from
eb8ad2d to
7abdccc
Compare
cosmicexplorer
force-pushed
the
docs-1
branch
4 times, most recently
from
4df8902 to
a1ea3af
Compare
cosmicexplorer
force-pushed
the
docs-1
branch
2 times, most recently
from
01eebe8 to
9872e21
Compare
jrose-signal
reviewed
May 6, 2021
cosmicexplorer
force-pushed
the
docs-1
branch
2 times, most recently
from
9a476fa to
3206468
Compare
- Add module docs for the `libsignal_protocol` crate! - Add docs to the `device-transfer` crate! - Add docs to `address`! beef up the docs for `address` because this is an important struct! respond to review comments revert module visibility changes de-clutter the docstring for `.device_id()` add missing docs warning fix uuid deps add doctest for `ProtocolAddress::new()`! avoid pulling in uuid into dev-dependencies
jrose-signal
approved these changes
May 10, 2021
|
Ah, right, some doc comments will make it into the generated C header for Swift. You can run |
|
Added the generated swift ffi changes! |
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.
Problem
This is the first in a set of planned PRs to add inline documentation to the Rust API which can then be beautifully published with
cargo doc. See #285.I am not a Signal engineer. I am making my best guesses as to the appropriate docstring content. I think I've been able to do just fine, but please push back if I'm mischaracterizing anything -- it's easy for me to just revert anything that seems possibly too bikesheddable.
Solution
libsignal_protocolcrate.device_transfercrate.addressmodule.Result
We will have established a rapport for further improvements to the documentation and module layout as per #285!