Rewrite Rust documentation - part 1 #106
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
|
Apologies for the late reply, but this looks good till now. |
boswelja
commented
Jan 21, 2025
|
Hey, let me know once you are ready to convert this from draft to final. |
Sorry for the hold up, I've only been working on this on-and-off between work 😅 I think this branch is in a pretty good place for the public functions in lib.rs. I'd like to go over the other public functions in other files too, but happy to split that into a separate PR if you'd prefer |
|
That's cool. I will check this out and try to merge the PR today. Thanks for the contribution. Rust docs are much needed. |
boswelja
changed the title
|
What happened to the branch history 😬 |
boswelja
force-pushed
the
documentation
branch
from
78ba29a to
0b83f14
Compare
akshayballal95
approved these changes
Jan 28, 2025
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.
This brings essentially all of
lib.rs(including crate docs) to what I feel is a pretty good place. I'm sure there's room for improvement, and there's certainly more to document beyond there, but the main page should look pretty good now 😄