Improve comments #26
Merged
Improve comments #26
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
Codecov Report
@@ Coverage Diff @@
## master #26 +/- ##
=======================================
Coverage 89.34% 89.34%
=======================================
Files 6 6
Lines 807 807
=======================================
Hits 721 721
Misses 68 68
Partials 18 18 |
ktr0731
reviewed
Sep 8, 2020
There was a problem hiding this comment.
@fsmiamoto
Thanks for the great work! I'm not a native English speaker, so this kind of PR is very helpful.
I commented just one point, can you check it?
fuzzyfinder.go
Outdated
| @@ -604,16 +604,16 @@ func (f *finder) find(slice interface{}, itemFunc func(i int) string, opts []Opt | |||
| } | |||
| } | |||
|
|
|||
| // Find displays a UI that provides fuzzy finding against to the passed slice. | |||
| // The argument slice must be a slice type. If it is not a slice, Find returns | |||
| // Find displays an UI that provides fuzzy finding against the provided slice. | |||
There was a problem hiding this comment.
an UI
Should we use a instead of an?
There was a problem hiding this comment.
Good catch!
I didn't put much thought to it, but looks like a is the way to go here.
|
@ktr0731 |
ktr0731
approved these changes
Sep 8, 2020
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.
While reading the source code, I saw the opportunity to improve some of the comments to make them clearer and fix some typos.
Let me know what you think and thanks for the awesome project.