[issue31057] pydoc for tempfile.TemporaryDirectory should say it returns the name

[Irit Katriel]

Change by Irit Katriel :


--
stage:  -> resolved
status: pending -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31057] pydoc for tempfile.TemporaryDirectory should say it returns the name

[Irit Katriel]

Irit Katriel  added the comment:

The OP seems to have abandoned this and all it got was a +0 for changing, so I 
suggest we close it.

--
nosy: +iritkatriel
resolution:  -> wont fix
status: open -> pending

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31057] pydoc for tempfile.TemporaryDirectory should say it returns the name

[R. David Murray]

R. David Murray added the comment:

Boy, I wasn't thinking very clearly when I wrote that.

As pointed out on the PR, tempfile.TemporaryDirectory of course returns a 
TemporaryDirectory object.  That's in the nature of Python.  I was reading so 
poorly that I didn't even notice it was the docstring you were modifying :(

The main docs phrase this more clearly, especially the sentence that says the 
name can be retrieved from the name property (and I see I was wrong, it does 
use 'name', not 'path').  We don't want to copy all of the text from there, but 
it could be used as a model to improve the phrasing.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31057] pydoc for tempfile.TemporaryDirectory should say it returns the name

[R. David Murray]

R. David Murray added the comment:

It actually returns the path, since "name" often means the last component of 
the path.  Just saying "path" might be confused with pathlib, though.  So I 
guess we'd have to say "returning its path as a string", which sounds awkward.  
The original wording is in fact accurate, since most people will understand 
"the directory" as the directory path as a string.  I'm not sure this change 
would be an improvement.  I'm not saying no, though.  I guess you'd say I'm -0 
on changing it.

--
nosy: +r.david.murray

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31057] pydoc for tempfile.TemporaryDirectory should say it returns the name

[Roundup Robot]

Changes by Roundup Robot :


--
pull_requests: +2968

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue31057] pydoc for tempfile.TemporaryDirectory should say it returns the name

[Thomas Thurman]

New submission from Thomas Thurman:

Currently the pydoc for tempfile.TemporaryDirectory begins

"Create and return a temporary directory."

It doesn't explain anywhere *what* it returns (in fact, it returns the name of 
the directory as a string). The return type is further obscured by 
TemporaryDirectory being a context manager.

--
assignee: docs@python
components: Documentation
messages: 299317
nosy: Thomas Thurman, docs@python
priority: normal
severity: normal
status: open
title: pydoc for tempfile.TemporaryDirectory should say it returns the name
type: enhancement
versions: Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com