Conversation
So i figured i add these comments to provide a comprehensive overview of each core function's purpose, parameters, flow, and usage context. Each section describes the key responsibilities and interactions of the function within the larger system.
Author
|
This helps explaining the core functions of this server script |
|
Just imo but might be better to put this on an md file right in root folder. I guess you mostly care about this if you're reading the codebase but an md might be more intuitive since I might not look to the bottom of a file. |
Owner
|
agreed
|
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
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.
So i figured i add these comments to provide a comprehensive overview of each core function's purpose, parameters, flow, and usage context. Each section describes the key responsibilities and interactions of the function within the larger system.