Lack of documentation for "rename" function.

[GoogleCodeExporter]

What steps will reproduce the problem?
1.In the documentatio I found this:

rename(src, dst)
Renames a file or directory

Parameters: 
src – path to rename
dst – new name
Raises: 
ParentDirectoryMissingError – if a containing directory is missing
ResourceInvalidError – if the path or a parent path is not a directory or src 
is a parent of dst or one of src or dst is a dir and the other don’t
ResourceNotFoundError – if the src path does not exist


What is the expected output? What do you see instead?
What should we do, if the File or already exists.
I heard on linux a file must be replaced and on windows an error is thrown.


What version of the product are you using? On what operating system?
newest cvn

Original issue reported on code.google.com by [email protected] on 20 Feb 2013 at 6:06

[GoogleCodeExporter]

In regards to tightening up the semanitics of rename(), this discussion thread 
is relevant too: 
https://groups.google.com/group/pyfilesystem-discussion/browse_thread/thread/96a
466455c869c4f

Original comment by [email protected] on 20 Feb 2013 at 7:13