Title: mention explicitly Windows support for os.devnull
Type: enhancement Stage: commit review
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7, Python 2.6
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: akira, docs@python, eric.araujo, georg.brandl, terry.reedy
Priority: normal Keywords: patch

Created on 2010-05-14 07:43 by akira, last changed 2010-05-21 22:03 by georg.brandl. This issue is now closed.

File name Uploaded Description Edit
doc-os-devnull-windows-r81160.diff akira, 2010-05-14 07:43 os.devnull doc patch
Messages (5)
msg105688 - (view) Author: Akira Li (akira) * Date: 2010-05-14 07:43
Currently it is not obvious that os.devnull works on Windows.
msg105702 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-05-14 12:26
If there’s no note stating some object is only available on one platform, then it’s available for all. That said, for this case I agree with your patch.
msg105752 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2010-05-14 20:01
Given the mention of the posix example, I agree. The issue applies to 2.6 and 3.2 (that I checked) and so I assume to 2.7 and 3.1 also.

There is no doc string for devnull, which I presume should be in ntpath.

>>> help(os.devnull)
no Python documentation found for 'nul'

If this is a singular omission (as opposed to a general lack in that module), you might expand the patch to remedy that also.
msg105753 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-05-14 20:04
os.devnull is a string, so “pydoc os.devnull” will tell you about
strings, and “help(os.devnull)” will be evaluated to
“help('/dev/null')” which won’t match any topic. Same thing with os.sep
and other module data; the doc is in the module’s docstring.
msg106269 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-05-21 22:03
Thanks, applied in r81450.
Date User Action Args
2010-05-21 22:03:44georg.brandlsetstatus: open -> closed

nosy: + georg.brandl
messages: + msg106269

resolution: fixed
2010-05-14 20:04:23eric.araujosetmessages: + msg105753
2010-05-14 20:01:45terry.reedysetversions: + Python 2.6, Python 3.1, Python 2.7, Python 3.2
nosy: + terry.reedy

messages: + msg105752

stage: commit review
2010-05-14 12:26:23eric.araujosetnosy: + eric.araujo
messages: + msg105702
2010-05-14 07:43:13akiracreate