change *file to *filePath in function parameters #385
Merged
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 parameters are named ...file when in reality they are actually the path to that file.
When I see a parameter named "file", its easy to think that it is a
File
orBuffer
, or when its type isstring
, the file read to string. This change renames the occurrences where that is the case to "filePath" instead.It also helps maintain consistency: In functions such as https://github.com/themoeway/yomitan/blob/eb7bf9542c92ea7937d4b4a699ae2d47270da96b/test/document-test.js#L42
it is correctly named
htmlFilePath
.