Document utils and logic functions #11903
Open
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.
As I'm learning this codebase I find it hard if I need to look at implementation of each function to understand what it does.
Some of them are really non obvious (get) as this code base prefer short naming.
Here I gave some effort to document what fn do. Some very obvious predicates are out of scope.
Aside of createSubject, I didn't touch any code. in case of createSubject since it's really bottom down, I caught myself multiple times stunt about the name.
I would really appreciate early feedback to see do I continue or this is not something you would like to pursue right now.