Mailman 3 May 1996 - Doc-SIG

[PYTHON DOC-SIG] Internals documentation: what format?
by anthony baxter May 31, 1996

May 31, 1996

Something else to consider: I'd like the stuff on the python internals(*) that I started yonks ago to be finished up at some point - but I'm really not all that happy with the current format for the text (pod). Does anyone have suggestions for a better format for this stuff? I want to be able to generate HTML, and also something nicer, and I'd also like it to be fairly easy to write. Anyone? Anthony (*) <URL:http://www.dgs.monash.edu.au/~anthony/python/docs.html> ================= DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig(a)python.org administrivia to: doc-sig-request(a)python.org =================

2 2

[PYTHON DOC-SIG] RE: [PROGENV-SIG] Project proposal discussion document
by Monty Zukowski May 30, 1996

May 30, 1996

For what it's worth, the Sorcerer toolkit looks like an excellent approach to parse tree walking and translation. But of course it is in C. The newsgroup for it is comp.compilers.tools.pccts. Also look at <http://www.mcs.net/~tmoog/pccts.html>. I haven't actually used it myself but I've read the documentation quite a bit and love the LL approach to the problem. This may be useful for the translation of the internal python parse tree into the general framework structures. If only I had the time to spare... >---------- >From: Fred L. Drake[SMTP:fdrake@CNRI.Reston.Va.US] >Sent: Thursday, May 30, 1996 11:38 AM >To: Progenv-SIG Mailing List; Doc-SIG Mailing List >Subject: [PROGENV-SIG] Project proposal discussion document > > I am advancing a proposal for a project which would benefit from the >input of the members of both doc-sig and progenv-sig. I have prepared >a >discussion document describing the project in general terms in more >detail >than I present in this message, but a brief summary is appropriate. > > My intention is to produce tools which can analyze Python source >code, >potentially as it is imported into a running Python process, and >perform >sufficient analysis to create a representation of the object hierarchy >with as much documentation as can be derived from the source text and >documentation strings as possible. The data structure created by the >analysis should allow for programmatic examination as part of an >interactive development or debugging environment or for the generation >of >static documentation of a collection of modules. > > My hope is that this project can be a collaborative project of, >primarily, the progenv SIG with the doc SIG providing critical advisory >input and evaluation. As described above, the work appears to be of >sufficient general interest to warrent the involvement of many >contributors. At the same time, the work promises enough modularity >that >individuals need not invest huge amounts of time to provide a >meaningful >contribution. The most significant investment to be made before >applications may be created within the project framework involves >reaching >a consensus on the definable stages of the project and precise >definitions >of the underlying data architecture. > > ================= DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig(a)python.org administrivia to: doc-sig-request(a)python.org =================

1 0

[PYTHON DOC-SIG] Preparing for IPC-IV
by Michael McLay May 29, 1996

May 29, 1996

As the coordinator for the doc-sig, I've been asked to give a presentation on the SIG and to set up the arrangements for the SIG meeting at the conference. If you are on this list and will be attending the conference please send me a note if you will be participating in the SIG discussion. Also indicate which other SIG discussions would take priority over the doc-sig session. There has been some discussion on the format for doc strings. If you have an opinion on this subject, or if you have done some work on tools to process doc strings, please speak up. I'd like to have some slides on the subject for the Tuesday morning presentation on the doc-sig. My initial guess is that we would need no more than 30-45 minutes for a SIG meeting on Thursday. Does anyone think we need more time to discuss issues and plan for future work? Michael ================= DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig(a)python.org administrivia to: doc-sig-request(a)python.org =================

1 0