[Doc-SIG] PEP-0216

[Jim Fulton]

Ken Manheimer wrote:
> 
> Well, it's remarkable to see StructuredText really considered after all
> this time.  I'm sorry that i probably won't have time to do more than
> kibitz.
> 
> Moshe wrote:
> 
> > At the moment, there are problems with ST-NG, which I've already
> > written about in a previous e-mail.
> 
> Which i understand to be:
> 
> | Current questions about ST-NG:
> |    - Does it support proper escaping of meta-characters? If I want to
> |      type *, or ', can I?

Why do you need this? Coud you give some examples? 
Please don't respond here though. See below.
 
(snip solution to problem I don't quite understand. ;)

> (Note - i *believe* that *example* text - blocks introduced by a paragraph
> ending in a '::' - should have all ST interpretation disabled, so the
> above examples would show the double quotes as well as the things they are
> quoting - if the double quote convention existed.)

Yes, no ST processing is done in examples.
 
> |    - Does my proposal about Python symbols identified as [<type>:<symbol>]
> |      make sense? How hard would it be to extend the current code to
> |      do just that?
> 
> I don't understand the question, and don't have the time to follow
> back a second level of indirection to track down your proposal.  (And
> i don't think i'll have time to do the legwork to investigate, if i
> *did* understand the question:-(  )

I know how you feel.

It would help us (Ken and I), and I suspect others, alot if the
Moshe's problem's with structured text could be documented in
a more durable form than email messages.

I took the liberty of creating a page in the StructuredText Wiki:
http://dev.zope.org/Members/jim/StructuredTextWiki/DocumentationStrings

to collect ideas for and comments on using StructuredText for 
doc strings.

I'd appreciate it if people could add proposals and comments
there. It's a Wiki page, meaning it can be edited through the
web. To make changes, you need to be logged in to zope.org. 
Membership on zope.org is free. The editing format is, of
course, StructuredText. :)

Jim

--
Jim Fulton           mailto:jim@digicool.com
Technical Director   (888) 344-4332              Python Powered!
Digital Creations    http://www.digicool.com     http://www.python.org

Under US Code Title 47, Sec.227(b)(1)(C), Sec.227(a)(2)(B) This email
address may not be added to any commercial mail list with out my
permission.  Violation of my privacy with advertising or SPAM will
result in a suit for a MINIMUM of $500 damages/incident, $1500 for
repeats.