Corrected a typo in File's documentation #5933
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
RX14
approved these changes
Apr 9, 2018
| @@ -568,7 +568,7 @@ class File < IO::FileDescriptor | |||
| Crystal::System::File.link(old_path, new_path) | |||
| end | |||
|
|
|||
| # Creates a symbolic link at *new_path* to an existing file given by *old_path. | |||
| # Creates a symbolic link at *new_path* to an existing file given by *old_path*. | |||
There was a problem hiding this comment.
Does old_path really need to exist and be a file?
There was a problem hiding this comment.
The function does let you create broken symlinks.
There was a problem hiding this comment.
So maybe change it to Creates a symbolic link at *new_path* pointing to *old_path*? But these argument names are not very good either... so maybe it should be reworked in a separate PR.
There was a problem hiding this comment.
More apt would be src_path + dest_path.
There was a problem hiding this comment.
Or target and link_name from man ln. But changing the argument names should probably be a separate PR (unless @Givralix want's to tackle this here).
There was a problem hiding this comment.
I think it's better if you do it.
wooster0
approved these changes
Apr 10, 2018
straight-shoota
approved these changes
Apr 11, 2018
sdogruyol
approved these changes
Apr 12, 2018
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.
No description provided.