Fix and modernize docs a bit #25
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
Contributor
Author
|
I see now there were also some styling changes automatically made by |
xadaemon
requested changes
May 20, 2025
Owner
xadaemon
left a comment
xadaemon
left a comment
There was a problem hiding this comment.
There's the one thing I commented, otherwise very good, thanks
src/daemon.rs
Outdated
Comment on lines
158
to
159
| /// Can be used to continue some work on the parent after the fork. | ||
| /// **NOTE:** This hook must call `std::process::exit()`. |
Owner
There was a problem hiding this comment.
It doesn't need to call exit(), it can call anything really, the main point is it's not expected to return ever thus the return type being !, so as long as it never returns the compiler will be happy.
Contributor
Author
There was a problem hiding this comment.
Alright, how's this?
xadaemon
approved these changes
May 21, 2025
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.
Previously, the docs wouldn't actually pass because of warnings in
cargo docand also the docs were in parts incorrect. I also tried fix grammar and add examples where appropriate.