style: add comments #588
Open
style: add comments #588
Conversation
This file contains 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
Little bit of refactoring to simplify the flow. - No need for an else branch when the if branch ends with a return - path length is compared to 0 at the beginning of the function, no need to check it's not 0 at the end
findContext() is really doing two jobs, so renamed to describe what else it's doing. It's probably best to split into multiple functions, but this seemed simplest for now.
tkurki
requested changes
Nov 1, 2020
| parts.reduce((cursor, part) => { | ||
| if(typeof cursor[part] === 'undefined') { | ||
| return cursor[part] = {} | ||
| } | ||
| return cursor[part] | ||
| }, this.sources) | ||
|
|
||
| // Uh, shouldn't something be done with the result of the reduce? What if | ||
| // the pointed to value isn't found? |
There was a problem hiding this comment.
You already documented what this does: creating elements as needed, using reduce cursor as a temp variable.
There was a problem hiding this comment.
I'm still confused. All this does is create elements, it doesn't actually update anything. Notice that context and timestamp aren't referenced in the body of the method. (Which means my comment is wrong, it's descending into this.sources, not context.)
There was a problem hiding this comment.
Ok, so
- it is handling this.sources and
contextis not needed nor used here, should be removed - it is not updating timestamp, which it should be doing, so a bug - add a FIXME comment in this documentation PR?
- your comment about descending into sources of the context is not correct, so to get this PR merged please remove that
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add code comments to the code to aid understanding.
I'm trying to wrap my head around some of the details of the signalk implementation and adding comments seemed like the most efficient way to do this. I figured others would benefit from the work.
There's some very light refactoring in here where it simplified the explanation.