Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write 'Using Python on Platform X' documents #35304

Closed
anthonybaxter mannequin opened this issue Oct 10, 2001 · 9 comments
Closed

Write 'Using Python on Platform X' documents #35304

anthonybaxter mannequin opened this issue Oct 10, 2001 · 9 comments
Assignees
@birkenfeld
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@anthonybaxter
Copy link
Mannequin

anthonybaxter mannequin commented Oct 10, 2001

BPO 469773
Nosy @freddrake, @akuchling, @birkenfeld

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2007-12-04.18:12:55.858>
created_at = <Date 2001-10-10.06:28:40.000>
labels = ['type-feature', 'docs']
title = "Write 'Using Python on Platform X' documents"
updated_at = <Date 2007-12-04.18:12:55.847>
user = 'https://bugs.python.org/anthonybaxter'

bugs.python.org fields:

activity = <Date 2007-12-04.18:12:55.847>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2007-12-04.18:12:55.858>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2001-10-10.06:28:40.000>
creator = 'anthonybaxter'
dependencies = []
files = []
hgrepos = []
issue_num = 469773
keywords = []
message_count = 9.0
messages = ['6885', '6886', '6887', '6888', '6889', '6890', '55186', '57982', '58199']
nosy_count = 4.0
nosy_names = ['fdrake', 'akuchling', 'anthonybaxter', 'georg.brandl']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue469773'
versions = []
@anthonybaxter
Copy link
Mannequin Author

anthonybaxter mannequin commented Oct 10, 2001

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.

@anthonybaxter anthonybaxter mannequin assigned freddrake Oct 10, 2001
@anthonybaxter anthonybaxter mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Oct 10, 2001
@anthonybaxter anthonybaxter mannequin assigned freddrake Oct 10, 2001
@anthonybaxter anthonybaxter mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Oct 10, 2001
@freddrake
Copy link
Member

Logged In: YES
user_id=3066

I agree.

Where would you suggest the information be added?

@anthonybaxter
Copy link
Mannequin Author

anthonybaxter mannequin commented Oct 25, 2001

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.

@freddrake
Copy link
Member

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.

@anthonybaxter
Copy link
Mannequin Author

anthonybaxter mannequin commented Nov 11, 2004

Logged In: YES
user_id=29957

What about instead a new "Using Python" document. There's a
bunch of overlap between the platforms. We can then also
have separate chapters for Mac, Win, Unix. I think trying to
produce platform specific docs is going to be a headache in
the long run.

@akuchling
Copy link
Member

Changing summary to be more accurate.

@birkenfeld
Copy link
Member

See bpo-223599 (which I closed as duplicate of this) for a few specific
Windows questions.

@birkenfeld
Copy link
Member

This will hopefully be done in GHOP.

@birkenfeld
Copy link
Member

Okay, now we have documents for Unix, Windows and Mac!

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@birkenfeld birkenfeld

Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@birkenfeld @akuchling @freddrake