➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: os.symlink docstring is ambiguous.
Type: Stage:
Components: None Versions:
process
Status: closed Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: brett.cannon, jemfinch
Priority: normal Keywords:

Created on 2003-05-13 20:53 by jemfinch, last changed 2022-04-10 16:08 by admin. This issue is now closed.

Messages (3)
msg16002 - (view) Author: Jeremy Fincher (jemfinch) Date: 2003-05-13 20:53 
>>> 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
msg16003 - (view) Author: Jeremy Fincher (jemfinch) Date: 2003-05-13 21:13 
Logged In: YES 
user_id=99508

(ignore that last comment...brain fart...)
msg16004 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2003-06-11 00:20 
Logged In: YES 
user_id=357491

Made the docstring match the official docs: "Create a symbolic 
link pointing to src named dst."  Applied as revision 2.300  for 
2.3 and revision 2.216.4.11 for the 2.2 branch.
History
Date User Action Args
2022-04-10 16:08:45adminsetgithub: 38499
2003-05-13 20:53:23jemfinchcreate