Re: [Doc-SIG] Does the "is" operator only matter for mutable object?

2011-03-06 Thread Laura Creighton
In a message of Mon, 07 Mar 2011 10:30:08 +1000, Nick Coghlan writes: >On Mon, Mar 7, 2011 at 9:08 AM, Laura Creighton wrote: >> Singleton objects such as ``True``, ``False``, and ``None`` are always >> the same object. The canonical way to test whether an object is >> a sin

Re: [Doc-SIG] Does the "is" operator only matter for mutable object?

2011-03-06 Thread Laura Creighton
In a message of Mon, 07 Mar 2011 00:08:38 +0100, Laura Creighton writes: oops, that one escaped before I was done. The other point was that I wondered about the section title itself. 5.8. Comparing Sequences and Other Types This reads as if we are comparing types, when that is not what this

Re: [Doc-SIG] Does the "is" operator only matter for mutable object?

2011-03-06 Thread Laura Creighton
I've been doing more thinking, and I think the problem is more deeply rooted than this. From the original doc: > The operators is and is not compare whether two objects are really the same > object; > this only matters for mutable objects like lists. This is actually wrong. If x is y, then y

Re: [Doc-SIG] Does the "is" operator only matter for mutable object?

2011-03-05 Thread Laura Creighton
In a message of Sun, 06 Mar 2011 10:59:55 +1100, "Steven D'Aprano" writes: >The more I think about this the more I agree with Fred Drake that we >should keep this simple. The documentation for the ``is`` operator is >not the place for a discussion of implementation-specific optimizations. > >

Re: [Doc-SIG] Does the "is" operator only matter for mutable object?

2011-03-05 Thread Laura Creighton
In a message of Sat, 05 Mar 2011 09:06:22 PST, Aahz writes: >+1 -- here's my rewrite for a bit more clarity: > >The operators ``is`` and ``is not`` compare whether two objects are >really the same object (have the same memory location). Immutable >objects with the same value and type may be cached

Re: [Doc-SIG] alternatives to epydoc?

2010-10-06 Thread Laura Creighton
In a message of Wed, 06 Oct 2010 09:52:15 PDT, Bill Janssen writes: >I've been documenting UpLib with a combo of ReST for the standalone >docs, and epydoc for the API documentation. But epydoc seems to be >dying a slow death of non-maintenance. It won't work with docutils 0.6 >or 0.7, and Python

[Doc-SIG] ReStructured Text Mime Type?

2009-05-21 Thread Laura Creighton
I'd like to be able to send people ReST files as mail and have them automatically displayed in their browser. What mime type should I call them? And what should I put in /etc/mailcap to make this work? Somebody has got to have been here before me. :) Laura __

Re: [Doc-SIG] What to do next for 2.6?

2008-08-31 Thread Laura Creighton
In a message of Sun, 31 Aug 2008 14:22:04 EDT, "A.M. Kuchling" writes: >This weekend I made a final revision pass over the 2.6 "What's New" >document and am now finished with it (barring any small corrections or >omissions that come in). > >What should I do now with my Python doc time? Georg, do y

Re: [Doc-SIG] British or American spellings?

2007-08-11 Thread Laura Creighton
In a message of Sat, 11 Aug 2007 08:41:09 CDT, [EMAIL PROTECTED] writes: > >In the core Python documentation should we strive for some consistency in >spelling where British and American English differ (e.g., "favor" >vs. "favour")? > >Skip I don't think so. There are actually more than 2 variant

Re: [Doc-SIG] [Python-Dev] The docs, reloaded

2007-05-19 Thread Laura Creighton
Wow. Nice job. Thank you so very much. Laura ___ Doc-SIG maillist - Doc-SIG@python.org http://mail.python.org/mailman/listinfo/doc-sig

Re: [Doc-SIG] non-ascii docstrings

2006-03-24 Thread Laura Creighton
I have never seen a module where the -*- coding -*- is not the same as the docstring, either. And the greatest number of times I have seen this is where people are using some company-wide tool, possibly third-party and possibly to integrate with java code -- to extract the docstrings, and also ha

[Doc-SIG] Improving the documenting process.

2006-01-02 Thread Laura Creighton
- Forwarded Message Laura Creighton wrote: > In a message of Sat, 31 Dec 2005 22:13:02 EST, Chad Whitacre writes: > >>Laura, >> >>Thanks for giving me an opportunity to clarify my proposal. > > >>On the other hand, I confess that I don't follow your

Re: [Doc-SIG] [Python-Dev] that library reference, again

2005-12-31 Thread Laura Creighton
In a message of Sat, 31 Dec 2005 15:41:50 +1000, Nick Coghlan writes: >Ian Bicking wrote: >> Anyway, another even more expedient option would be setting up a >> separate bug tracker (something simpler to submit to than SF) and >> putting a link on the bottom of every page, maybe like: >> http://

Re: [Doc-SIG] proposal: a process for solving the Python Documentation Problem

2005-12-31 Thread Laura Creighton
In a message of Sat, 31 Dec 2005 00:19:35 EST, Chad Whitacre writes: >Dear All, > >Here is an attempt to outline a process by which we might clarify and >solve the "Python Documentation Problem." The attempt here is to work >from the outside in, starting with the end result we want to see, and >

Re: [Doc-SIG] what about OpenDocument?

2005-12-30 Thread Laura Creighton
you get 'binary file, no diffs available' your documentation starts living in a world of its own, a world that you have to visit periodically and do work to keep up with. Laura In a message of Sat, 31 Dec 2005 13:19:34 +1100, Christopher Armstrong writes: >On 12/31/05, Laura Creight

Re: [Doc-SIG] what about OpenDocument?

2005-12-30 Thread Laura Creighton
So it is a binary file format? If so, that will be a problem. Anything that produces output you cannot run through unix tools such as grep, and anything that you cannot edit in your favourite text editor will be a problem. Laura In a message of Fri, 30 Dec 2005 12:55:34 EST, Chad Whitacre writ

Re: [Doc-SIG] Python Tutorial - urllib2

2005-12-22 Thread Laura Creighton
Is there a list somewhere of exactly what it is that would need to be added to ReST in order to support writing Python documentation in ReST? Laura ___ Doc-SIG maillist - Doc-SIG@python.org http://mail.python.org/mailman/listinfo/doc-sig

Re: [Doc-SIG] [Python-Dev] status of development documentation

2005-12-21 Thread Laura Creighton
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

Re: [Doc-SIG] Creating howto directory in Python CVS

2005-08-29 Thread Laura Creighton
In a message of Mon, 29 Aug 2005 14:16:36 EDT, "A.M. Kuchling" writes: >On Mon, Aug 29, 2005 at 07:38:15PM +0200, Laura Creighton wrote: >> want to bother him personally about a personal page. If they were >> on python.org I would have sent my 'wish you had explai

Re: [Doc-SIG] Creating howto directory in Python CVS

2005-08-29 Thread Laura Creighton
In a message of Mon, 29 Aug 2005 14:03:39 EDT, "Fred L. Drake, Jr." writes: >On Monday 29 August 2005 13:38, Laura Creighton wrote: > > I had a small problem with reg-exp how to the other day. > > what decided me against report it to amk was the idea that I didn't >

Re: [Doc-SIG] Creating howto directory in Python CVS

2005-08-29 Thread Laura Creighton
In a message of Mon, 29 Aug 2005 13:30:02 EDT, "Fred L. Drake, Jr." writes: >On Monday 29 August 2005 09:28, A.M. Kuchling wrote: > > Actually they're on amk.ca now. People find them pretty well -- type > > "regular expression" into Google and the HOWTO is the top hit; it's > > the second hit for

Re: [Doc-SIG] Good API doc generation in the Python world recently?

2005-01-28 Thread Laura Creighton
do for pypy it would be good if we could drop it into epydoc, make it part of CPython, and make everybody happy. Laura Creighton ___ Doc-SIG maillist - Doc-SIG@python.org http://mail.python.org/mailman/listinfo/doc-sig