search

Raynes / fs

File system utilities for Clojure.
453 stars 119 forks source link

Added a comment clarifying the link call in its docstring. #65

Closed pcn closed 8 years ago

pcn commented 10 years ago

On unix systems, the link() system call uses the convention

link(const char oldpath, const char newpath)

However in java7 (when createLink was added), the createLink call asks the programmer to use the arguments in the opposite order:

createLink(newpath, oldpath)

fs/link goes with the java convention, even though the name shadows the system call's name. This commit is adding info to the docstring clarifying which file needs to exist and which one will be created. It also re-names the arguments to make clear which one must already exist, and which one is being created.

Raynes commented 8 years ago

Sorry, too old to commit. If ya wanna fix the merge commits I'm happy to merge it!

Raynes commented 8 years ago

Actually fixed and signed off myself. Thanks!