[DOC] Enhanced RDoc for ::cp #74
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
jeremyevans
requested changes
May 23, 2022
lib/fileutils.rb
Outdated
| @@ -631,16 +631,52 @@ def link_entry(src, dest, dereference_root = false, remove_destination = false) | |||
| end | |||
| module_function :link_entry | |||
|
|
|||
| # Copies files from +src+ to +dest+; | |||
| # +src+ may not be the path to a directory | |||
There was a problem hiding this comment.
This second part, describing what src and dest may not be seems weird. I would just drop the second part, and change the semicolon to a period. Near the end of method documentation, state that if +src+ is a directory, an exception is raised. You can completely remove the part about dest not being a path to a file, since that is allowed.
lib/fileutils.rb
Outdated
| # | ||
| # Copies a file content +src+ to +dest+. If +dest+ is a directory, | ||
| # copies +src+ to +dest/src+. | ||
| # If +src+ is the path to a file and +dest+ does not exist, copies +src+ to +dest+: |
There was a problem hiding this comment.
This is also true if dest is already a file.
jeremyevans
approved these changes
May 23, 2022
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
May 23, 2022
schneems
pushed a commit
to schneems/ruby
that referenced
this pull request
Jul 26, 2022
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.