Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread Paul Rubin
alex23 wuwe...@gmail.com writes: I'd still like to see this kept out of the official docs as much as possible, mostly for reasons of brevity clarity. I think the official docs should be considered definitive and not require a hermeneutic evaluation against user comments to ensure they're

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread Dave Angel
alex23 wrote: Paul Rubin http://phr...@nospam.invalid wrote: The PHP docs as I remember are sort of regular (non-publically editable) doc pages, each of which has a public discussion thread where people can post questions and answers about the topic of that doc page. I thought it worked

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread alex23
Paul Rubin http://phr...@nospam.invalid wrote: Such evaluation would only do them good.  The official docs are full of errors and omissions, which is why we have this thread going on here in the newsgroup. And there is a process for reporting and correcting such errors and omissions, which is

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread Kee Nethery
During all this conversation there was a ticket posted in the bug tracking system with the suggestion of each section in the official docs linking to a fixed wiki page that can contain user contributions. The ticket has been closed because this addition to the official docs is already in

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread r
On Aug 7, 11:03 am, Kee Nethery k...@kagi.com wrote: ...(snip) I'm looking forward to the acceleration of improvements to the   official docs based upon easy to provide user feedback. Glad to see   that the bug tracking system is going to not be the primary means for   documentation changes.

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread alex23
Kee Nethery k...@kagi.com wrote: I'm looking forward to the acceleration of improvements to the   official docs based upon easy to provide user feedback. Glad to see   that the bug tracking system is going to not be the primary means for   documentation changes. I'm not sure what you see as

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread David Robinow
On Fri, Aug 7, 2009 at 1:48 PM, alex23wuwe...@gmail.com wrote: Why exactly is posting an open comment on a bug tracker somehow inferior to posting an open comment on a wiki? When one believes that development is controlled by a cabal which is jealous of outsiders and actively prevents

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread alex23
David Robinow drobi...@gmail.com wrote:  When one believes that development is controlled by a cabal which is jealous of outsiders and actively prevents improvements to the docs, any change, even if only in perception, helps to weaken the hold of the evil forces holding back the success of

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread Kee Nethery
On Aug 7, 2009, at 10:48 AM, alex23 wrote: Kee Nethery k...@kagi.com wrote: I'm looking forward to the acceleration of improvements to the official docs based upon easy to provide user feedback. Glad to see that the bug tracking system is going to not be the primary means for documentation

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread r
On Aug 7, 3:35 pm, Kee Nethery k...@kagi.com wrote: (snip) Kee, that was an eloquent and enlighting post and i think it speaks volumes to the lack of inclusion of all Pythoneers in this community. Not to mention the viscous attitudes and self indulgence we have around here. For those of you with

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread Steven D'Aprano
On Fri, 07 Aug 2009 13:35:26 -0700, Kee Nethery wrote: Why exactly is posting an open comment on a bug tracker somehow inferior to posting an open comment on a wiki? It's a good question and deserves a good answer. * Fewer Steps * Immediate * Does not need to be formally reviewed *

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread Carl Banks
On Aug 7, 9:25 pm, Steven D'Aprano st...@remove-this- cybersource.com.au wrote: If you want an open-access documentation system go right ahead and build one. There are plenty of wikis available to use, and the Python docs are freely available as your starting point. I might even contribute

Re: Python docs disappointing - group effort to hire writers?

2009-08-07 Thread Paul Rubin
Steven D'Aprano st...@remove-this-cybersource.com.au writes: As for the rest, you're right that the current bug-tracker puts up barriers to people submitting comments and bugs. That's actually a good thing. The only thing worse than not enough information is too much information, and the

Re: Python docs disappointing - group effort to hire writers?

2009-08-06 Thread Terry Reedy
RayS wrote: At 08:35 PM 8/5/2009 -0700, r wrote: ... Any real sense of community is undermined -- or even destroyed -- to be replaced by virtual equivalents that strive, unsuccessfully, to synthesize a sense of community. I've brought up the idea of the quasi-community doc that PHP uses to

Re: Python docs disappointing - group effort to hire writers?

2009-08-06 Thread Kee Nethery
On Aug 6, 2009, at 6:55 AM, Terry Reedy wrote: RayS wrote: At 08:35 PM 8/5/2009 -0700, r wrote: ... Any real sense of community is undermined -- or even destroyed -- to be replaced by virtual equivalents that strive, unsuccessfully, to synthesize a sense of community. I've brought up the

Re: Python docs disappointing - group effort to hire writers?

2009-08-06 Thread alex23
Kee Nethery wrote: As I struggle through trying to figure out how to make python do   simple stuff for me, I frequently generate samples. If some volunteer   here would point me towards the documentation that would tell me how I   can alter the existing Python docs to include sample code, I'd

Re: Python docs disappointing - group effort to hire writers?

2009-08-06 Thread Paul Rubin
alex23 wuwe...@gmail.com writes: No offence, but the last thing the official documentation needs is example code written by people learning how to code. Suggest changes, request clarifications, submit samples for review, sure, but direct modification by users? I've seen the PHP docs; thanks

Re: Python docs disappointing - group effort to hire writers?

2009-08-06 Thread alex23
Paul Rubin http://phr...@nospam.invalid wrote: The PHP docs as I remember are sort of regular (non-publically editable) doc pages, each of which has a public discussion thread where people can post questions and answers about the topic of that doc page.  I thought it worked really well.  The

Re: Python docs disappointing - group effort to hire writers?

2009-08-05 Thread r
On Aug 4, 12:55 am, David Lyon david.l...@preisshare.net wrote: It isn't totally about the writers... Peoples egos are also at stake - it seems. If Fred X wrote Doc Y.. they don't want their name taken off.. So they generally speaking don't want the docs changed. If you talk too much about

Re: Python docs disappointing - group effort to hire writers?

2009-08-05 Thread RayS
At 08:35 PM 8/5/2009 -0700, r wrote: ... Any real sense of community is undermined -- or even destroyed -- to be replaced by virtual equivalents that strive, unsuccessfully, to synthesize a sense of community. I've brought up the idea of the quasi-community doc that PHP uses to good effect.

Re: Python docs disappointing - group effort to hire writers?

2009-08-04 Thread David Lyon
It isn't totally about the writers... Peoples egos are also at stake - it seems. If Fred X wrote Doc Y.. they don't want their name taken off.. So they generally speaking don't want the docs changed. If you talk too much about docs.. you can be told you're OT.. even in a thread about docs...

Re: Python docs disappointing - group effort to hire writers?

2009-08-04 Thread alex23
On Aug 4, 3:55 pm, David Lyon david.l...@preisshare.net wrote: It isn't totally about the writers... Peoples egos are also at stake - it seems. Citation please. If Fred X wrote Doc Y.. they don't want their name taken off.. So they generally speaking don't want the docs changed. Ditto. If

Re: Python docs disappointing

2009-08-02 Thread kj
In 09bf4f17-40a5-4bad-81d3-1950545b7...@g6g2000vbr.googlegroups.com Carl Banks pavlovevide...@gmail.com writes: snip Thanks. Your remarks at least confirm that my impression was not simply due to my noob ignorance: the keyboard-accessible docs are indeed as poor as they look. kynn --

Re: Python docs disappointing

2009-08-02 Thread Mohan Parthasarathy
I am a newbie and about a month old with Python. There is a wealth of material about Python and I am really enjoying learning Python. One thing that could have helped Python documentation is that instead of the very raw doc string, it could have used something like PythonDoc (java doc style) so

Re: Python docs disappointing

2009-08-02 Thread Chris Rebert
On Fri, Jul 31, 2009 at 1:10 PM, kj no.em...@please.post wrote: I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python rather poor, overall. I'm sure that Python experts don't have this problem: they have internalized some good ways to access the

Re: Python docs disappointing

2009-08-02 Thread Christian Heimes
Mohan Parthasarathy schrieb: I am a newbie and about a month old with Python. There is a wealth of material about Python and I am really enjoying learning Python. One thing that could have helped Python documentation is that instead of the very raw doc string, it could have used something like

Re: Python docs disappointing

2009-08-01 Thread Nobody
On Fri, 31 Jul 2009 20:10:45 +, kj wrote: I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python rather poor, overall. FWIW, I find the module documentation to be mostly adequate. What's missing is a human-readable language *manual*. The tutorial omits

Re: Python docs disappointing

2009-08-01 Thread jkn
On Aug 1, 4:18 am, Terry Reedy tjre...@udel.edu wrote: This is one area where Windows users seems to have an advantage. The standard installer includes the doc set as a Windows help file. I often keep that open in one window while programming in others. I only later discovered that this was a

Re: Python docs disappointing

2009-08-01 Thread Tim Golden
jkn wrote: The ActiveState distribution also includes the doc set as a CHM file (the canonical version didn't used to; one reason why I've used ActiveState in the past). It has done for quite some while now: Python 2.3 was the first and that was released, what, six years ago. Still, you're

Re: Python docs disappointing

2009-08-01 Thread jkn
Hi Tim On Aug 1, 8:32 pm, Tim Golden m...@timgolden.me.uk wrote: Unfortunately, the combination of the python 2.6 CHM helpfile style, and the KChmViewer application gives me body text which is almost unreadable (black text on dark blue background). I'm not sure if this a bug in

Re: Python docs disappointing

2009-08-01 Thread jkn
update: if I set 'use KHTMLPart-based widget' instead of 'QTextBrowser- based Widget' to display HTML content in the application settings of KchmViewer, all is readable. Hurrah! I wonder if it is picing up some QT stylesheet I have lying around in an over-clever way... J^n --

Python docs disappointing

2009-07-31 Thread kj
I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python rather poor, overall. I'm sure that Python experts don't have this problem: they have internalized some good ways to access the documentation, are productive with it, and therefore have lost the ability

Re: Python docs disappointing

2009-07-31 Thread Robert Kern
On 2009-07-31 15:10, kj wrote: I would love to know how experienced Python programmers quickly zero in on the Python documentation they need. http://docs.python.org/library/urllib I use Firefox's Quick Searches feature to make getting this URL as fast as possible: m urllib -- Robert

Re: Python docs disappointing

2009-07-31 Thread r
On Jul 31, 3:10 pm, kj no.em...@please.post wrote: I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python rather poor, overall. [snip] If you mean the built-in docs i *highly agree* with you. if you mean docs/tutorials available across the WWW i *highly

Re: Python docs disappointing

2009-07-31 Thread Carl Banks
On Jul 31, 1:10 pm, kj no.em...@please.post wrote: I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python rather poor, overall. I'm sure that Python experts don't have this problem: they have internalized some good ways to access the documentation, are

Re: Python docs disappointing

2009-07-31 Thread Carl Banks
On Jul 31, 1:55 pm, Mark Lawrence breamore...@yahoo.co.uk wrote: Apart from that what have the Pythonistas ever done for us? Nothing!:) Please don't feed the trolls. And if you do feed the trolls don't smile at them. Carl Banks -- http://mail.python.org/mailman/listinfo/python-list

Re: Python docs disappointing

2009-07-31 Thread kj
In e22013d0-fbad-44e0-919b-ad5bb5f2d...@g19g2000vbi.googlegroups.com Carl Banks pavlovevide...@gmail.com writes: (omg you have to use a *mouse*) That's precisely the point. There's a huge number of programmers out there who, like me, *hate* to use the mouse while they're coding. It is truly

Re: Python docs disappointing

2009-07-31 Thread r
On Jul 31, 4:16 pm, Carl Banks pavlovevide...@gmail.com wrote: On Jul 31, 1:10 pm, kj no.em...@please.post wrote: I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python rather poor, overall. I'm sure that Python experts don't have this problem: they

Re: Python docs disappointing

2009-07-31 Thread Carl Banks
On Jul 31, 2:28 pm, kj no.em...@please.post wrote: In e22013d0-fbad-44e0-919b-ad5bb5f2d...@g19g2000vbi.googlegroups.com Carl Banks pavlovevide...@gmail.com writes: (omg you have to use a *mouse*) That's precisely the point.  There's a huge number of programmers out there who, like me,

Re: Python docs disappointing

2009-07-31 Thread Nikolaus Rath
Carl Banks pavlovevide...@gmail.com writes: This is one area in which Perl still whips Python... No way. Perl's man pages are organized so poorly there is no ergonomic pit deep enough to offset them. Quick, what man page is the do statement documented in? Of course there is: $ perldoc -f

Re: Python docs disappointing

2009-07-31 Thread Carl Banks
On Jul 31, 3:09 pm, kj no.em...@please.post wrote: In 09bf4f17-40a5-4bad-81d3-1950545b7...@g6g2000vbr.googlegroups.com Carl Banks pavlovevide...@gmail.com writes: snip Thanks.  Your remarks at least confirm that my impression was not simply due to my noob ignorance: the keyboard-accessible

Re: Python docs disappointing

2009-07-31 Thread Chris Jones
On Fri, Jul 31, 2009 at 06:03:25PM EDT, Carl Banks wrote: On Jul 31, 2:28 pm, kj no.em...@please.post wrote: In e22013d0-fbad-44e0-919b-ad5bb5f2d...@g19g2000vbi.googlegroups.com Carl Banks pavlovevide...@gmail.com writes: (omg you have to use a *mouse*) That's precisely the point.  

Re: Python docs disappointing

2009-07-31 Thread r
On Jul 31, 4:53 pm, Mark Lawrence breamore...@yahoo.co.uk wrote: r wrote: On Jul 31, 4:16 pm, Carl Banks pavlovevide...@gmail.com wrote: On Jul 31, 1:10 pm, kj no.em...@please.post wrote: I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python rather

Re: Python docs disappointing - group effort to hire writers?

2009-07-31 Thread Kee Nethery
I too find the Python docs not very useful and it really slows down my learning curve. I wonder if it would make sense to find good tech writers, get a quotes, and get some professionally written documentation WITH LOTS OF EXAMPLES added to the standard Python documentation tree. I'd

Re: Python docs disappointing

2009-07-31 Thread Martin P. Hellwig
kj wrote: cut python has poor documentation explanation Well to a level I agree with you. If you are totally new to programming _and_ you won't/can't invest in educational material _and_ have an adversity for looking up resources using a web browser _and_ don't have the patience for trial and

Re: Python docs disappointing

2009-07-31 Thread Mark Lawrence
r wrote: On Jul 31, 4:53 pm, Mark Lawrence breamore...@yahoo.co.uk wrote: r wrote: On Jul 31, 4:16 pm, Carl Banks pavlovevide...@gmail.com wrote: On Jul 31, 1:10 pm, kj no.em...@please.post wrote: I'm pretty new to Python, and I like a lot overall, but I find the documentation for Python

Re: Python docs disappointing

2009-07-31 Thread Aahz
In article h4vnm4$jv...@reader1.panix.com, kj no.em...@please.post wrote: In e22013d0-fbad-44e0-919b-ad5bb5f2d...@g19g2000vbi.googlegroups.com Carl Banks pavlovevide...@gmail.com writes: (omg you have to use a *mouse*) That's precisely the point. There's a huge number of programmers out there

Re: Python docs disappointing

2009-07-31 Thread Steven D'Aprano
On Fri, 31 Jul 2009 21:28:36 +, kj wrote: In e22013d0-fbad-44e0-919b-ad5bb5f2d...@g19g2000vbi.googlegroups.com Carl Banks pavlovevide...@gmail.com writes: (omg you have to use a *mouse*) That's precisely the point. There's a huge number of programmers out there who, like me, *hate*

Re: Python docs disappointing

2009-07-31 Thread Tim Chase
Martin P. Hellwig wrote: kj wrote: [excerpt of previously snipped content restored] I'm sure that I can find a full description of this parameter if I fire up Google, and search online. In fact, more likely than not, I'll find far more documentation than I want. But my point is that a

Re: Python docs disappointing

2009-07-31 Thread Terry Reedy
Tim Chase wrote: It may not be an adversity for looking things up using a web-browser, but rather the need to access documentation offline. Whether on an airplane or simply away from a wifi/landline connection, there are plenty of times I'm coding offline (another reason I'm happy to have

Re: Python docs disappointing

2009-07-31 Thread Ned Deily
In article h50c6a$dg...@ger.gmane.org, Terry Reedy tjre...@udel.edu wrote: This is one area where Windows users seems to have an advantage. The standard installer includes the doc set as a Windows help file. I often keep that open in one window while programming in others. I only later

<    1   2