Increase discoverability of "flip-flop" meaning #920
Merged
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
Some programmers might not be familiar with what a flip-flop is or what it does. Further, it can be tricky (but not impossible) to learn more by searching for "Ruby flip-flop" without being sidetracked into summertime beach footwear options. Adding the word "operator" helps narrow down internet searches, and providing a link to the relevant Wikipedia page allows readers to easily learn more. At the time of this commit, the Wikipedia page discusses flip-flop operators within Ruby specifically while also giving a good overview of why it is good practice to avoid using them. When a style guide entry advises against using a particular pattern without explaining what the pattern is, the reader might not be confident that they can successfully follow the guideline. After all, it is difficult to avoid doing something when you don't understand what the "something" is.
|
That's make sense. Thanks! |
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.
Some programmers might not be familiar with what a flip-flop is or what it does. Further, it can be tricky (but not impossible) to learn more by searching for "Ruby flip-flop" without being sidetracked into summertime beach footwear options.
Adding the word "operator" helps narrow down internet searches, and providing a link to the relevant Wikipedia page allows readers to easily learn more. At the time of this commit, the Wikipedia page discusses flip-flop operators within Ruby specifically while also giving a good overview of why it is good practice to avoid using them.
When a style guide entry advises against using a particular pattern without explaining what the pattern is, the reader might not be confident that they can successfully follow the guideline. After all, it is difficult to avoid doing something when you don't understand what the "something" is.