Skip to content

Conversation

@BurdetteLamar
Copy link
Member

Change two references to C methods chown and chmod to refer instead to Ruby methods File#chown and File#chmod (which are those actually called).

@BurdetteLamar
Copy link
Member Author

Here's a question: For things verbose, we refer to 'an equivalent command' such as cp or rm; should we be linking to the man pages for those commands? (If so, that would be in a future PR.)

@peterzhu2118
Copy link
Member

For things verbose, we refer to 'an equivalent command' such as cp or rm; should we be linking to the man pages for those commands?

Do you mean the man page for the Linux commands? If so, I don't think that's necessary. Most programmers should be aware of what they do. In case they're not, the documentation here explains it fairly well.

@BurdetteLamar
Copy link
Member Author

For things verbose, we refer to 'an equivalent command' such as cp or rm; should we be linking to the man pages for those commands?

Do you mean the man page for the Linux commands? If so, I don't think that's necessary. Most programmers should be aware of what they do. In case they're not, the documentation here explains it fairly well.

Agreed. We have one reference to man page install; remove in next PR?

@peterzhu2118
Copy link
Member

Agreed. We have one reference to man page install; remove in next PR?

I think install is an exception that I think we should keep because the install command isn't very commonly used, so developers may not be aware of what it does (in fact, it's the first time I've heard of it). Alternatively, we could expand on the documentation of FileUtils.install to have more details, it's a bit difficult to tell the difference between FileUtils.install and FileUtils.cp right now.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants