Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document utils and logic functions #11903

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ultrox
Copy link

@ultrox ultrox commented May 19, 2024

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.

Copy link

codesandbox bot commented May 19, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@ultrox ultrox force-pushed the document-util-and-logic-fn branch 11 times, most recently from 47d2865 to dc2ec87 Compare May 19, 2024 07:14
@ultrox ultrox changed the title Document util and logic fn Document utils and logic functions May 19, 2024
@ultrox ultrox force-pushed the document-util-and-logic-fn branch from 6d2b21d to 28cdb2f Compare May 19, 2024 07:51
@ultrox ultrox force-pushed the document-util-and-logic-fn branch from 28cdb2f to 3ebb9e1 Compare May 19, 2024 08:04
@bluebill1049
Copy link
Member

Thank you very much for this, i will take a look this weekend and come back to you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants