classification
Title: help for a module should list supported platforms
Type: feature request Stage:
Components: Documentation Versions: Python 3.2, Python 3.1, Python 2.7, Python 2.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: amaury.forgeotdarc, georg.brandl, rickysarraf, tjreedy (4)
Priority: Keywords

Created on 2009-09-02 16:43 by rickysarraf, last changed 2009-09-04 19:03 by tjreedy.

Messages (6)
msg92173 - (view) Author: Ritesh Raj Sarraf (rickysarraf) Date: 2009-09-02 16:42
Whey I do a help (python-module), I get the help text as follows:

Help on module tempfile:

NAME
    tempfile - Temporary files.

FILE
    /usr/lib/python2.5/tempfile.py

MODULE DOCS
    http://www.python.org/doc/2.5.4/lib/module-tempfile.html

DESCRIPTION
    This module provides generic, low- and high-level interfaces for
    creating temporary files and directories.  The interfaces listed
    as "safe" just below can be used without fear of race conditions.
    Those listed as "unsafe" cannot, and are provided for backward
    compatibility only.

The link to the webpage lists the supported platforms for the module.
It would be good to have an entry stating the list of platforms supported
by the module, in the module doc itself.
msg92226 - (view) Author: Amaury Forgeot d'Arc (amaury.forgeotdarc) Date: 2009-09-03 23:11
I'm not sure to understand. The web page says the module "works on all 
supported platforms." Many python features works equally well on all 
platforms, and I don't feel necessary to repeat this everywhere.
The differences between platforms are more interesting IMO.
msg92231 - (view) Author: Ritesh Raj Sarraf (rickysarraf) Date: 2009-09-04 05:04
Take "help os" or "help os.fork" for example.

WIth the help output that they provide, how am I supposed to know that
os.fork is only supported on Unix.

We can also go with the assumption that the modules shipped are
cross-platform. But then, for those that aren't, I don't think we mention
that in the help file documentation.
msg92236 - (view) Author: Amaury Forgeot d'Arc (amaury.forgeotdarc) Date: 2009-09-04 07:31
What makes you think that the tempfile module is not cross-platform?
msg92240 - (view) Author: Ritesh Raj Sarraf (rickysarraf) Date: 2009-09-04 07:58
I never said that I think it is not cross-platform.

My point is, it should be good to list down a module's dependency in the
python help docs.

Like:
tempfile

Supported Platforms: ALL
Exception: On Platform foo, feature tempfile.bar() is not available.
msg92264 - (view) Author: Terry J. Reedy (tjreedy) Date: 2009-09-04 19:03
*most* modules are platform independent, and for those, I do not think
anything needs to be said. 

I agree with OP that it would be nice if interactive help indicated
platform dependencies, if and when such is not done now. I have no idea
if any of such addition could be easily automated.
History
Date User Action Args
2009-09-04 19:03:30tjreedysetnosy: + tjreedy

messages: + msg92264
versions: + Python 2.6, Python 3.1, Python 2.7, Python 3.2, - Python 2.5
2009-09-04 07:58:20rickysarrafsetmessages: + msg92240
2009-09-04 07:31:24amaury.forgeotdarcsetmessages: + msg92236
2009-09-04 05:04:30rickysarrafsetmessages: + msg92231
2009-09-03 23:11:19amaury.forgeotdarcsetnosy: + amaury.forgeotdarc
messages: + msg92226
2009-09-02 16:43:43rickysarrafsettype: feature request
2009-09-02 16:43:00rickysarrafcreate