Improves readability of code examples - #224
Open
tomasbonco wants to merge 3 commits into
Open
tomasbonco wants to merge 3 commits into
tomasbonco wants to merge 3 commits into
Conversation
Improves readability especially for beginners. * When comparing, using `===` instead of `==` is just a good practice. Additionally, stops reader from questions "Can this be null or undefined? Do I need to read docs?". * Changing `let` to `const` separates things that change from those that don't change, so reader don't have to keep in mind all variables. * Adding extra brackets to `for` emphasis there is a code on the same line and reader should not jump directly to the next line.
JeanMeche
reviewed
May 19, 2024
JeanMeche
reviewed
May 19, 2024
| export function effect(cb) { | ||
| let destructor; | ||
| let c = new Signal.Computed(() => { destructor?.(); destructor = cb(); }); | ||
| const c = new Signal.Computed(() => { destructor?.(); destructor = cb(); }); |
Author
There was a problem hiding this comment.
Well, I know this is sort of personal taste, but in my opinion this is acceptable. Lambda functions are often one-liners and the content in this case is not too complex. I assume a reader is used to reading the rest of the line. Understanding the purpose of the code is going to be the issue, but not its style.
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
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.
Signals themselves are quite complex. Aim of this small PR is to slightly improve readability of code samples. I hope especially beginners and devs not familiar with the topic appreciate it.
===instead of==is just a good practice. Additionally, stops reader from questions "Why they didn't use===? Can this be null or undefined? Do I need to read docs?".lettoconstseparates things that change from those that don't change, so reader don't have to keep in mind all variables.foremphasis there is a code on the same line and reader should not jump directly to the next line.