Document and organise xwrap.rs (Questions) #511
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
|
I have order the xwrap in the way Im thinking the files should be set. I you think some functions should come under a different category let me know. |
|
This some great endeavour and it looks really nice! |
Merged
|
I feel this is ready now, however if there are any addition/change suggestions please let me know. I would suggest some extra testing in case of regression if I made an error reducing the functions. |
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.
Tag @VuiMuich, @mautamu, @lex148, @hertg. Opening now as have some questions. I was going to organise all the getters together and setters together, etc (and maybe some refactoring to reduce code). However I think maybe splitting them into different files would make it easier to find and understand what you want easier (which is the goal of this PR, to make the xlib side easier for new users tackle), which would all be in a new directory called xwrap (where xwrap.rs is currently).
This is part of a string of documentation I hoping to tackle (anyone can help), where I am following https://doc.rust-lang.org/rust-by-example/hello/comment.html. We should also try and add as many links to relevant documentation that new users can go to to understand that thing better. E.g. I thinking of putting a link to the xlib documentation for each given function called in xwrap.
Many Thanks.