refactor(Template): clarify JSConfigHelper naming, comments, and docblocks#61050
Draft
joshtrichards wants to merge 6 commits into
Draft
refactor(Template): clarify JSConfigHelper naming, comments, and docblocks#61050joshtrichards wants to merge 6 commits into
joshtrichards wants to merge 6 commits into
Conversation
- Add class docblock - Add key function docblocks - Rename variables for improved clarity - Replace vague comments - Add key clarifying comments Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
joshtrichards
added
2. developing
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
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
1 participant
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.
Summary
I'm working on some other changes in this class, but figured I'd submit these easier to review changes first.
This PR aims to improve readability of
JSConfigHelperby clarifying naming, comments, and docblocks. It also adds basic unit test coverage.Specific changes:
private readonlyTODO
Anybody know why
canUserValidatePassword()isprotectedrather than private?Checklist
3. to review, feature component)stable32)AI (if applicable)