Improve the Cargo documentation #87
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
Drabble
commented
May 8, 2022
maxammann
previously approved these changes
May 9, 2022
|
I just merged in a larger PR. Let me know if I should resolve merge conflicts. |
Drabble
commented
May 11, 2022
|
Minor hint: Instead of adding PR comments you can also directly edit files in the PR via the wrench icon :) |
Co-authored-by: Max Ammann <max@maxammann.org>
Drabble
commented
May 12, 2022
Drabble
commented
May 12, 2022
maxammann
previously approved these changes
May 12, 2022
Drabble
commented
May 12, 2022
Drabble
commented
May 12, 2022
maxammann
previously approved these changes
May 12, 2022
Drabble
commented
May 12, 2022
maxammann
approved these changes
May 12, 2022
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.
I have been reading the code for my own comprehension. I took the opportunity to try and improve the overall Cargo documentation of the project. My understanding is still not complete and there may be issues in my comments. I am more than open to criticism and I still need to go through my comments one more time.
I have also added a few FIXME comments where I found potential issues, these I would like to discuss before merging them in the main branch.
There are multiple points to be defined before we can merge:
Shared thread stateon the[crate::io:shared_thread_state]module so it looks better in the Cargo documentation? I think it can make sense to have a placeholder in some cases that we can improve when we have more time and knowledge.🚨 Test instructions
Run the following command to open the documentation:
✔️ PR Todo