docs(issue-2): add detailed docstrings and internal comments #26
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
Signed-off-by: micheal-ndoh <[email protected]>
micheal-ndoh
requested review from
AssahBismarkabah,
Christiantyemele,
Valsuh45 and
sinke237
Christiantyemele
requested changes
Apr 6, 2025
Member
Christiantyemele
left a comment
Christiantyemele
left a comment
There was a problem hiding this comment.
Very Good work overall
Signed-off-by: micheal-ndoh <[email protected]>
Signed-off-by: micheal-ndoh <[email protected]>
…in function Signed-off-by: micheal-ndoh <[email protected]>
… function Signed-off-by: micheal-ndoh <[email protected]>
… function Signed-off-by: micheal-ndoh <[email protected]>
…ndoh/async-chat into docs/issue-2-docstrings
…arify stdout output behavior Signed-off-by: micheal-ndoh <[email protected]>
Christiantyemele
approved these changes
Apr 9, 2025
micheal-ndoh
requested review from
Blindspot22 and
USHER-PB
and removed request for
AssahBismarkabah and
sinke237
USHER-PB
approved these changes
Apr 9, 2025
Valsuh45
approved these changes
Apr 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 PR resolves issue #2 by adding detailed docstrings to every function in the codebase and inline comments where necessary for clarity and easier usage when published to crates.io.
Changes:
///) to all public structs and functionsconnection.rs,group.rs,group_table.rs,lib.rs,utils.rsand main.rs.Closes #2
@Christiantyemele Ready for review 🙌