[ python-Bugs-469773 ] docs should include man page

[SourceForge.net]

Bugs item #469773, was opened at 2001-10-10 02:28
Message generated for change (Comment added) made by fdrake
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=469773&group_id=5470

Category: Documentation
Group: Feature Request
Status: Open
Resolution: None
Priority: 5
Submitted By: Anthony Baxter (anthonybaxter)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: docs should include man page

Initial Comment:
Some stuff that's in the man page (e.g. the 
syntax for the -W switch) doesn't appear to
be in the HTML documentation. If it is there, 
it's _very_ well hidden away.


----------------------------------------------------------------------

>Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2004-11-11 01:33

Message:
Logged In: YES 
user_id=3066

I'll note that the "Macintosh Library Modules" document
deals with this sort of issue for the Mac (though it may be
out of date for Mac OS X; not sure).  The first chapter is
an introduction to using Python on the Mac, and the
remaining chapters provide module reference documentation.

What's needed is something like the first chapter of that
for Unix and Windows.  I'm not sure where it should go,
though; I don't want that material in the main library
reference.

This almost makes me want three platform-specific documents,
one for Windows, one for Unix, and the existing Mac OS
document, each containing the relevant "Using Python on ..."
chapter, followed by chapters containing platform-specific
modules.  Modules that apply to two or more of the platforms
would continue to be documented in the main library
reference.  The distutils modules are already documented in
the distutils documentation as well.  This should be fine
since the "global" module index is the normal general entry
point anyway.

----------------------------------------------------------------------

Comment By: Anthony Baxter (anthonybaxter)
Date: 2001-10-25 02:17

Message:
Logged In: YES 
user_id=29957

See, that's the problem :) It's not clear where this
might go - it's almost a "Using Python" section, which,
as far as I can see, doesn't really exist. 

This might also include stuff about the Windows GUI and
other interfaces for using python.

If a shorter-term "just get the -W stuff in" approach is
wanted, then extended the lib/module-warnings might be the
approach... but it really does seem like it needs to be
somewhere central. 

----------------------------------------------------------------------

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2001-10-24 22:12

Message:
Logged In: YES 
user_id=3066

I agree.

Where would you suggest the information be added?

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=469773&group_id=5470