📝 Add documentation to packet_falcon_core
#24
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
VixieTSQ
requested changes
Oct 11, 2022
Collaborator
VixieTSQ
left a comment
VixieTSQ
left a comment
There was a problem hiding this comment.
These are all nitpicks and absolutely not blockers. But what we discussed before is still a problem. I could not get a solid grasp on what the "seed-flavored" traits are really meant for and the external input stuff needs to be explained better.
Comment on lines
+5
to
+6
| /// Helper type to write iterators over implementors of the seed-less flavored | ||
| /// traits to a minecraft connection. |
Collaborator
There was a problem hiding this comment.
What does it mean to write iterators to a Minecraft connection? As a Bytes? Each individually?
Member
Author
There was a problem hiding this comment.
Iterators over PacketWrite, meaning iterators over more complex types. U should use the specialized implementations for byte arrays.
Comment on lines
+19
to
+21
| #[doc = "Transparent wrapper around an "] | ||
| #[doc = stringify!($base)] | ||
| #[doc = "."] |
Collaborator
There was a problem hiding this comment.
Suggested change
| #[doc = "Transparent wrapper around an "] | |
| #[doc = stringify!($base)] | |
| #[doc = "."] | |
| #[doc = concat!("Transparent wrapper around an ", stringify!($base), "."] |
This might be more readable
| } | ||
|
|
||
| impl $var { | ||
| /// Return the stored value. |
Collaborator
There was a problem hiding this comment.
Suggested change
| /// Return the stored value. | |
| /// Return the inner value. |
Sounds more rusty
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.
Apart from the derive macros, all items should be documented. Since this is the crate that does not depend on any other falcon crate, this should be understandable on its own.
Is that the case, is this clear and sufficient documentation?