Skip to content
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 copy_entry #76

Merged
merged 3 commits into from
May 25, 2022
Merged

[DOC] Enhanced RDoc for copy_entry #76

merged 3 commits into from
May 25, 2022

Conversation

BurdetteLamar
Copy link
Member

This PR experiments with using tree to display directory structure (both src and dest). If we decide to keep this, we'll need to add a note about tree in the intro.

#
# Copies a file system entry +src+ to +dest+.
# If +src+ is a directory, this method copies its contents recursively.
# This method preserves file types, c.f. symlink, directory...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want to drop this information. If removing this text, we should mention elsewhere what is not supported.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

lib/fileutils.rb Outdated
#
# If +src+ is a directory, recursively copies +src+ to +dest+:
#
# system('tree src1')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we are going to use tree, can we use --charset=ascii to stick to 7-bit ASCII characters?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be fine with me. Do you think we should use tree?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does make it a little easier to see what is going on, so I don't have a problem using it here and in the documentation for other recursive copy methods.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does make it a little easier to see what is going on, so I don't have a problem using it here and in the documentation for other recursive copy methods.

Done.

@BurdetteLamar
Copy link
Member Author

I've omitted the system(tree ...) as being unnecessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants