[Python-bugs-list] [ python-Bugs-737291 ] os.symlink docstring is ambiguous.

[SourceForge.net]

Bugs item #737291, was opened at 2003-05-13 16:53
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=737291&group_id=5470

Category: None
Group: None
Status: Open
Resolution: None
Priority: 5
Submitted By: Jeremy Fincher (jemfinch)
Assigned to: Nobody/Anonymous (nobody)
Summary: os.symlink docstring is ambiguous.

Initial Comment:
>>> print os.symlink.__doc__
symlink(src, dst)

Create a symbolic link.

I find that to be ambiguous -- personally, when I read
it, I picture the symlink as the source pointing to the
destination, but apparently Python considers the
symlink to be the "destination" file pointing at the
source (the file).

I propose simply changing "src" in the docstring to be
"filename" and "dst" in the docstring to be "linkname."
 That would cut out the ambiguity.

(It's unfortunate, btw, that os.symlink takes its
arguments in the opposite order of the UNIX ln command.)

Jeremy

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=737291&group_id=5470