Improve documentation #384
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
* Improve README and share with rustdocs * Improve docs of one-shot servers * Tidy up lib.rs * Fix doc warning in router.rs Delete documentation link from README as it doesn't look good in the docs. The documentation link (https://docs.rs/ipc-channel) should be moved to About->Website on the repository page at github.com.
|
Looks like one of the benches hit a flake and needs re-running (I don't think I can do that). I haven't changed any code. |
jdm
reviewed
Jan 28, 2025
README.md
Outdated
|
|
||
| ## Semantic differences from Rust channels | ||
|
|
||
| * Rust channels are MPSC (multi-producer, single-consumer) whereas ipc-channels are SPSC (single-producer, single-consumer). |
There was a problem hiding this comment.
This isn't true—you can clone IPC senders and the receiver will receive from all of them.
There was a problem hiding this comment.
Oops. I was confusing this with the single-connect behaviour of one-shot servers.
jdm
approved these changes
Jan 28, 2025
|
@jdm Thanks for merging. How do you feel about setting the documentation link (https://docs.rs/ipc-channel) as About->Website on the repository page on github.com? |
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.
Delete documentation link from README as it doesn't look good in the docs. The documentation link (https://docs.rs/ipc-channel) should be moved to About->Website on the repository page at github.com.