[Documentation] Summary & Readability improvement #125
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
|
@Mathys-Gasnier thanks so much for this great work, and apologies for only just getting around to reviewing it! |
|
No worry, thanks for the amazing library |
nicbarker
pushed a commit
that referenced
this pull request
Jan 14, 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.
When working on the rust bindings I found it hard to go around the readme, and lost myself often...
This PR tries to make the doc a bit easier to use by adding a summary to make finding information easier.
It also increase readability of certain sections by adding separators between functions/macros/structs.
If you think anymore changes to the README can improve readability i'm open to add them too.