-
Notifications
You must be signed in to change notification settings - Fork 33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] Enhanced RDoc for ::ln_s #72
Conversation
@jeremyevans, I'm still feeling my way here:
As our strategy evolves, I may need to revise some of the previous work here. |
lib/fileutils.rb
Outdated
# | ||
# FileUtils.ln_s('src2.txt', 'dest2.txt') # Raises Errno::EEXIST. | ||
# | ||
# When +src+ and +dest+ are both paths to directories, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This behavior when dest is a directory is the same when src is a file or a directory. I don't think we need a separate example block for it, maybe just update the above text to mention that it applies both when src is a file and when it is a directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cannot add this to the relevant list item above b/c the covering text says "When +src+ is the path to an existing file:".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then consider reorganizing the sections to avoid the repetition.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. One section now, with examples with src as both file and directory.
@jeremyevans, there's no re-review thingy, but this is ready for you to check. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please pick an example group to remove (see comment), then this is OK to merge without further review.
lib/fileutils.rb
Outdated
# When +dest+ is the path to a directory, | ||
# creates a symbolic link at <tt>dest/src</tt> pointing to +src+: | ||
# | ||
# # File src: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same behavior for both file/directory src cases, so let's just pick one and use it, there is no benefit for keeping both examples.
@jeremyevans, I've re-confirmed the examples, including the verbose output, b/c of the renumbering. |
No description provided.