CommonClient: add more docstrings and comments #3821
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
github-actions
bot
added
affects: core
Exempt-Medic
added
the
is: documentation
hesto2
approved these changes
Aug 21, 2024
| The Command Processor will parse every method of the class that starts with "_cmd_" as a command to be called | ||
| when parsing user input, i.e. _cmd_exit will be called when the user sends the command "/exit". | ||
|
|
||
| The decorator @mark_raw can be imported from MultiServer and tells the parser to only split on the first |
There was a problem hiding this comment.
This is super helpful, I didn't know about mark_raw 🔥
nicholassaylor
approved these changes
Sep 5, 2024
There was a problem hiding this comment.
Cannot speak for the correctness of the new docstrings as I am not very familiar with CommonClient code. However, taking a brief look at the code that it documents, nothing seems out of place.
Giving a soft approval as long as someone with more experience with client code looks at this.
Exempt-Medic
added
waiting-on: core-review
NewSoupVi
approved these changes
Sep 26, 2024
AustinSumigray
pushed a commit
to AustinSumigray/Archipelago
that referenced
this pull request
Jan 4, 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.
What is this fixing or adding?
adds more documentation to what CommonClient is doing and how you are expected to extend it
all descriptions are based on my understanding of the relevant code so correct me if i'm wrong / if there is better wording
How was this tested?
reading
If this makes graphical changes, please attach screenshots.