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

chore: add comments clarifying potentially confusing terms #7694

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

KenLSM
Copy link
Contributor

@KenLSM KenLSM commented Sep 18, 2024

Problem

Confusing terminology while reviewing.

Solution

Add comments to clarify context that was not explicitly noted. Context was found only after reading the source PR.

Breaking Changes

  • No - this PR is backwards compatible

@kevin9foong
Copy link
Member

kevin9foong commented Sep 20, 2024

Thinking about removing the use of the word 'use' in 'useTemplate' or changing it another word eg, utilizeTemplate instead to reduce need for comments as much as possible.

@KenLSM
Copy link
Contributor Author

KenLSM commented Sep 20, 2024

Thinking about removing the use of the word 'use' in 'useTemplate' or changing it another word eg, utilizeTemplate instead to reduce need for comments as much as possible.

It's an interesting topic. "Use Template" is a business / product term that might cause confusion if we swap it out to "Utilize Template". I.e., PM / Design / Users refer to them as "Use Template" while on the code POV, it is codified as utilizeTemplate and the reason for that is because React chose to abuse the term use. 😄

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.

2 participants