fix (shared-utils): Improve readability and consistency in code comments (fix #8528) #8529
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
Improvements that apply to all comments: - Consistent use of periods - Consistent use of commas - Consistent capitalization - Correct use of articles (a, an, the) Improvements to specific comments: - Correct pluralization in the description for helper functions - Reword for clarity and break into shorter sentences the description for `polyfillBind` function - Reword for clarity the description for `genStaticKeys` function - Add a previously missing description for `looseIndexOf` function Fixes: vuejs#8528
sagirk
force-pushed
the
fix/shared-util-comments
branch
from
9300403
to
77fc789
Compare
|
@LinusBorg @yyx990803 The source code is very readable. It was a pleasure to go through I would really appreciate it if you took a look at this or tagged someone who could. Thanks for continuing to work on this awesome library! |
|
@LinusBorg @yyx990803 Any chance that this could get merged? |
chrisvfritz
approved these changes
Oct 9, 2018
f2009
pushed a commit
to f2009/vue
that referenced
this pull request
Jan 25, 2019
…omments (vuejs#8529) Improvements that apply to all comments: - Consistent use of periods - Consistent use of commas - Consistent capitalization - Correct use of articles (a, an, the) Improvements to specific comments: - Correct pluralization in the description for helper functions - Reword for clarity and break into shorter sentences the description for `polyfillBind` function - Reword for clarity the description for `genStaticKeys` function - Add a previously missing description for `looseIndexOf` function Fixes: vuejs#8528
aJean
pushed a commit
to aJean/vue
that referenced
this pull request
Aug 19, 2020
…omments (vuejs#8529) Improvements that apply to all comments: - Consistent use of periods - Consistent use of commas - Consistent capitalization - Correct use of articles (a, an, the) Improvements to specific comments: - Correct pluralization in the description for helper functions - Reword for clarity and break into shorter sentences the description for `polyfillBind` function - Reword for clarity the description for `genStaticKeys` function - Add a previously missing description for `looseIndexOf` function Fixes: vuejs#8528
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.
Improvements that apply to all comments:
Improvements to specific comments:
for
polyfillBindfunctiongenStaticKeysfunctionlooseIndexOffunctionFixes: #8528
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
devbranch for v2.x (or to a previous version branch), not themasterbranchfix #xxx[,#xxx], where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information: