On 22 Dec 2005, at 3:51, Michael Hudson wrote:
> "Fredrik Lundh" <[EMAIL PROTECTED]> writes:
>
>> Checked the python-list archives lately? If you google c.l.python
>> for the
>> word "documentation", you'll find recent megathreads with subjects
>> like
>> "bitching about the documentation",
Facundo Batista wrote:
> 2005/12/21, Phillip J. Eby <[EMAIL PROTECTED]>:
>
>> 3. Fredrik believes that more people would participate in updating Python
>> documentation if it didn't require a LaTeX toolchain or LaTeX-friendly
>> editor.
>
> I'm sure he's right. I'm not talking about any random u
> "Fred" == Fred L Drake, <[EMAIL PROTECTED]> writes:
Fred> On Thursday 22 December 2005 13:23, [EMAIL PROTECTED] wrote:
>> Who is asking this of potential contributors? I know you, Aahz
>> and I have repeatedly told people on c.l.py that LaTeX
>> knowledge is not necessary.
On 12/22/05, Phillip J. Eby <[EMAIL PROTECTED]> wrote:
> At 04:08 PM 12/22/2005 -0500, Martin Blais wrote:
> >ReST does an amazing job of inferring generic document structures from
> >text, but for documenting source code, you really want to be able to
> >say "This is a function", "this is an optio
Phillip J. Eby wrote:
> At 10:27 AM 12/22/2005 +0100, Walter Dörwald wrote:
>> Phillip J. Eby wrote:
>>
>> > [...]
>> >
>> > If someone has examples of actual "Pythondoc" markup that don't
>> translate
>> > to reST, I'd be really interested in seeing them, just for my own
>> > education. Of cour
At 04:08 PM 12/22/2005 -0500, Martin Blais wrote:
>ReST does an amazing job of inferring generic document structures from
>text, but for documenting source code, you really want to be able to
>say "This is a function", "this is an optional argument", etc. ReST
>does not provide this kind of functi
On Thursday 22 December 2005 13:44, Neal Norwitz wrote:
> I would help assuming this is easy--meaning a single click to remove a
> comment.
It looks like the system the MySQL folks are using makes it easy, but I've not
tried polluting their documentation with tests, just in case. :-)
In gener
On Thursday 22 December 2005 13:23, [EMAIL PROTECTED] wrote:
> Who is asking this of potential contributors? I know you, Aahz and I have
> repeatedly told people on c.l.py that LaTeX knowledge is not necessary.
> Plain text is okay. What do we need to do to squash this meme?
As Andrew noted,
On Thursday 22 December 2005 13:39, Facundo Batista wrote:
> Very interesting. What I don't know here is how to submit patches...
"Patches" certainly isn't the right word for changes not described as source
diffs. I cleaned up some text about that on python.org earlier.
> I mean, if they were
Charles Cazabon wrote:
> It might also be nice if the modules that rely on blocking mode being set
> on sockets (basically anything using socket.ssl()) actually explicitly set
> that
> first. Right now, if you do socket.setdefaulttimeout() to a non-None
> value and then try to use anything that d
On 12/21/05, Barry Warsaw <[EMAIL PROTECTED]> wrote:
> On Wed, 2005-12-21 at 20:36 +0100, Fredrik Lundh wrote:
>
> > I'm not really interested in optimizing for you, I'm interested in
> > optimizing
> > for everyone else. They already know HTML. They don't know ReST, and
> > I doubt they care ab
On Thu, Dec 22, 2005 at 12:23:03PM -0600, [EMAIL PROTECTED] wrote:
> Who is asking this of potential contributors? I know you, Aahz and I have
> repeatedly told people on c.l.py that LaTeX knowledge is not necessary.
One comment on a bug to this effect was found. I don't think there's
a point in
Steve Holden wrote:
> Jim Fulton wrote:
>
>>Yesterday, I needed to make a web request in a program (actually a test)
>>that could block indefinately, so I needed to set a socket timeout.
>>Unfortunately, AFAICT none of urllib, urllib2, httplib provide options to set
>>the timeout on the sockets th
On 12/22/05, A.M. Kuchling <[EMAIL PROTECTED]> wrote:
>
> I had lunch with Fred the other day, and he was worried about whether
> anyone would garden the comments to remove spam.
I would help assuming this is easy--meaning a single click to remove a comment.
n
2005/12/22, [EMAIL PROTECTED] <[EMAIL PROTECTED]>:
> Tony & other python-dev summarizers (and maybe Cameron Laird for the c.l.py
> summaries): please make a note of this in your next summary. The
> I-can't-contribute-because-I-don't-know-LaTeX notion has to die, die, die.
Very interesting. What
Michael Chermside wrote:¨
> Me too. Specifically, I think if you make it really easy to write notes
> on the docs you will get some helpful documentation content. You will
> also get lots of things that are too lengthy or exhaustive, to specific
> to one person's problem, helpdesk style questions,
Fred> Some people are getting asked to convert their documentation
Fred> contributions to LaTeX themselves...
Who is asking this of potential contributors? I know you, Aahz and I have
repeatedly told people on c.l.py that LaTeX knowledge is not necessary.
Plain text is okay. What do we
2005/12/22, Michael Chermside <[EMAIL PROTECTED]>:
> > (I'm also concerned that the whole thing could end up being misused as a
> > help
> > desk, littering the docs with questions about application problems.)
>
> Me too. Specifically, I think if you make it really easy to write notes
> on the do
I wrote:
> My own favorite idea is to create a comment-on-the-docs mechanism
> allowing both COMMENTS, and PROPOSED EDITS.
Fred Drake replies:
> I'm unclear on what you buy with having these two labels; are comments things
> that (presumably) get ignored by the documentation editor, or are the
> p
On Thursday 22 December 2005 11:44, Fred L. Drake, Jr. wrote:
> I've
> generally stated that I'm willing to perform conversion, making plain text
> / ReST completely acceptable for documentation contributions. Others have
> commonly converted plain text to LaTeX as well.
I've started a list o
Just a quick note based on some of the discussion on the Doc-SIG list:
Some people are getting asked to convert their documentation contributions to
LaTeX themselves, and that *is* a barrier to contribution. I've generally
stated that I'm willing to perform conversion, making plain text / ReST
Steve Holden <[EMAIL PROTECTED]> wrote:
> Jim Fulton wrote:
> > Yesterday, I needed to make a web request in a program (actually a test)
> > that could block indefinately, so I needed to set a socket timeout.
> > Unfortunately, AFAICT none of urllib, urllib2, httplib provide options to
> > set
> >
Whenever people have demanded that I write documentation in html
I have always done this:
all my documentation, as output from a text editor.
All subsequent formatting to be done by somebody else who doesn't
find dealing with html as excruciatingly painful as I do.
I suspect there are lots of
Jim Fulton wrote:
> Yesterday, I needed to make a web request in a program (actually a test)
> that could block indefinately, so I needed to set a socket timeout.
> Unfortunately, AFAICT none of urllib, urllib2, httplib provide options to set
> the timeout on the sockets they use. I ended up havin
Yup. I just went through a similar exercise with urllib2. It wasn't
too hard to plumb through a different HTTPHandler that set the
timeout, but it would be much nicer as a default option. It seems
like a 30 minute project; might fit in an "odds and ends" sprint.
Jeremy
On 12/22/05, Jim Fulton
Yesterday, I needed to make a web request in a program (actually a test)
that could block indefinately, so I needed to set a socket timeout.
Unfortunately, AFAICT none of urllib, urllib2, httplib provide options to set
the timeout on the sockets they use. I ended up having to roll my own
code to
Hello all!
I just submitted Patch #1388073, designed to make unittest's TestCase
class easier to subclass, and I'd appreciate a review of/feedback on
the code there.
While recently working on a subclass of unittest.TestCase to support
TODO-tests, I found a large number of __-prefixed attributes i
At 10:27 AM 12/22/2005 +0100, Walter Dörwald wrote:
>Phillip J. Eby wrote:
>
> > [...]
> >
> > If someone has examples of actual "Pythondoc" markup that don't translate
> > to reST, I'd be really interested in seeing them, just for my own
> > education. Of course, I'd also be curious how common su
2005/12/21, Phillip J. Eby <[EMAIL PROTECTED]>:
> 3. Fredrik believes that more people would participate in updating Python
> documentation if it didn't require a LaTeX toolchain or LaTeX-friendly editor.
I'm sure he's right. I'm not talking about any random user that finds
a doc bug and wants to
On Thursday 22 December 2005 08:50, Michael Chermside wrote:
> Money is not a very effective motivator for this sort of work. (Well,
> in sufficient quantities it is, but the quantities required are
> quite large.) Offering *credit* is more effective -- a mention within
> a contributors list pe
On Thursday 22 December 2005 09:22, A.M. Kuchling wrote:
> I had lunch with Fred the other day, and he was worried about whether
> anyone would garden the comments to remove spam. That is indeed an
> issue, but I think we can cope with that problem once a system is
> built.
>
> Another worry
Steve Holden writes:
> Could the PSF help here by offering annual prizes for the best
> contributions to the documentation, or wouldn't that be an adequate
> motivator?
Money is not a very effective motivator for this sort of work. (Well,
in sufficient quantities it is, but the quantities required
On Thu, Dec 22, 2005 at 09:27:06AM +, Steve Holden wrote:
> Could the PSF help here by offering annual prizes for the best
> contributions to the documentation, or wouldn't that be an adequate
> motivator?
I think the most effective thing would be to award a grant to someone
to build a real
Ian Bicking wrote:
> This is somewhat tangential to this discussion, but I did have the
> Python documentation in mind as a potential future target for
> Commentary: http://pythonpaste.org/comment/commentary/ -- which would
> allow more casual contributions that seem to work well for other project
"Fredrik Lundh" <[EMAIL PROTECTED]> writes:
> Checked the python-list archives lately? If you google c.l.python for the
> word "documentation", you'll find recent megathreads with subjects like
> "bitching about the documentation", "opensource documentation problems"
> and "python documentation s
Michael Chermside <[EMAIL PROTECTED]> writes:
> So I have a counter-proposal. Let's NOT create a hierarchy of abstract
> base types for the elementary types of Python.
+1
Cheers,
mwh
--
how are the jails in israel?
well, the one I was in was pretty nice
>> http://trentm.com/python/
Fredrik> you rule!
Actually, I think Trent rocks. Guido rules.
Skip
___
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe:
http://mail.python.org/mailman
Phillip J. Eby wrote:
> [...]
>
> If someone has examples of actual "Pythondoc" markup that don't translate
> to reST, I'd be really interested in seeing them, just for my own
> education. Of course, I'd also be curious how common such constructs are.
I'm using XML markup for our packages. E
[EMAIL PROTECTED] wrote:
> Fredrik> If you google c.l.python for the word "documentation", you'll
> Fredrik> find recent megathreads with subjects like "bitching about the
> Fredrik> documentation", "opensource documentation problems" and "python
> Fredrik> documentation should be b
Aahz wrote:
> On Wed, Dec 21, 2005, Michael Chermside wrote:
>> So I have a counter-proposal. Let's NOT create a hierarchy of abstract
>> base types for the elementary types of Python. (Even basestring feels
>> like a minor wart to me, although for now it seems like we need
>> it.) If the core prob
Fred L. Drake, Jr. wrote:
> > I'm not convinced it's the toolchain though. People hate writing
> > documentation. Getting people to contribute documentation is worse than
> > pulling teeth.
>
> I don't think it's the toolchain either. While most people don't have it,
> it's easier and easier
Torsten Bronger wrote:
> > [...] Are there any HTML-to-print converters that are better?
>
> I don't understand exactly how the HTML is to be used for Python but
> I assume that not everything could be done via CSS, so own
> converters will be necessary for perfect output.
If done right, it shou
Trent Mick wrote:
> > - could a cronjob that does this be set up on some python.org machine
> > (or on some volunteer's machine)
>
> I bit:
>
> http://trentm.com/python/
you rule!
thanks /F
___
Python-Dev mailing list
Python-Dev@python.org
http:
43 matches
Mail list logo
