[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Larry Hastings]

Larry Hastings  added the comment:

At last!  Thanks for reviving it, Cheryl!

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

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

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Larry Hastings]

Larry Hastings  added the comment:


New changeset e152169da95b52fa41931572bc90857253c4a5dd by larryhastings (Cheryl 
Sabella) in branch 'master':
bpo-16024: Doc cleanup regarding path_fd, dir_fd, follow_symlinks (GH-5505)
https://github.com/python/cpython/commit/e152169da95b52fa41931572bc90857253c4a5dd


--

___
Python tracker 

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

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Cheryl Sabella]

Cheryl Sabella  added the comment:

Larry,

I've made a pull request for your patch.  It seemed like most of the original 
text was still in place, so I thought you might still want these changes.  You 
had also made changes to the What's New, but I didn't include those changes.

--
nosy: +csabella
versions: +Python 3.8 -Python 3.3

___
Python tracker 

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

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Cheryl Sabella]

Change by Cheryl Sabella :


--
pull_requests: +5337

___
Python tracker 

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

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[A.M. Kuchling]

Changes by A.M. Kuchling a...@amk.ca:


--
nosy:  -akuchling

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

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Larry Hastings]

Larry Hastings added the comment:

I would, but I can't get it to apply cleanly, either to tip or to historical 
revisions back in Sepember.  Kaleb, what revision is the branch that you 
generated the diff from?

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Larry Hastings]

Larry Hastings added the comment:

p.s. Thanks for reviving the patch.  I forgot about this one!

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[A.M. Kuchling]

A.M. Kuchling added the comment:

Kaleb Robertson's changes look good.  Larry, do you want to go ahead and commit 
this?

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Kaleb Robertson]

Kaleb Robertson added the comment:

Adding a revision of the .diff file according to akuchling's comment.

--
nosy: +kkvr05
Added file: 
http://bugs.python.org/file30255/lch.supports_set.doc.cleanup.1-revised.diff

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[A.M. Kuchling]

A.M. Kuchling added the comment:

Patch looks good with two small changes.

* for consistency's sakes is used in 2 places; this should be sake, not the 
plural sakes.

* Normally the *path* argument specified to functions: 'specified to' sounds 
wrong, and IMHO would be better as 'provided to' or 'passed to'.

The last hunk in the patch to 3.3.rst, but the new text still seems an 
improvement.

--
nosy: +akuchling

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Larry Hastings]

New submission from Larry Hastings:

You know how you start pulling on a thread and before you notice you've 
unraveled the whole sweater?  I meant to do a simple *one line* fix on the docs 
and wound up with a nearly-300-line diff.  I claim it's all an improvement, 
though I'm willing to change it if there's something you don't like.

Definite improvements:
* supports_fd et al are :class:`set` objects, not :class:`~collections.Set`.  
Those are different.
* Linked to the specifying a file descriptor section in os from the relevant 
discussion in what's new.
* Availability: Unix goes above :versionadded.

Avowed improvements:
* supports_* now explicitly mention what values are permitted for their 
parameters.
* Lots of rewriting/munging in an effort to improve readability and precision.
* A couple places where it's read better than it is.

LGTU?

--
assignee: larry
components: Documentation
files: lch.supports_set.doc.cleanup.1.diff
keywords: patch
messages: 171155
nosy: georg.brandl, larry
priority: normal
severity: normal
stage: patch review
status: open
title: Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc
type: enhancement
versions: Python 3.3
Added file: http://bugs.python.org/file27276/lch.supports_set.doc.cleanup.1.diff

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[Arfrever Frehtes Taifersar Arahesis]

Changes by Arfrever Frehtes Taifersar Arahesis arfrever@gmail.com:


--
nosy: +Arfrever

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue16024] Doc cleanup regarding path=fd, dir_fd, follow_symlinks, etc

[STINNER Victor]

Changes by STINNER Victor victor.stin...@gmail.com:


--
nosy: +haypo

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16024
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com