Add detailed comments to improve readability and explain key design decisions #217
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
Member
|
This PR doesn't bring much value, I prefer to close it. |
Member
|
psf/cachecontrol#377 was closed with a similar reason. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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 update adds clear and necessary comments throughout the _process.py script. The comments explain the purpose and reasoning behind major code sections, including subprocess handling, memory usage tracking, profiling, and hook management. By adding these explanations, the code becomes easier to maintain, understand, and extend for future contributors. This change improves developer experience without altering any functional behavior of the script.