[IronPython] Internals documentation

[Dino Viehland]

We're picking up the RST files that IronPython documentation is based upon.  We have a tree structure which currently includes the unmodified docs and a modified version which is updated w/ new IronPython specific content and tweaks to some of the existing content where things differ.  We can then do a 3-way merge to bring in updates to the documentation.

I've created a place holder bug for tracking misc. improvements to the documentation so your suggestions don't get lost (http://ironpython.codeplex.com/WorkItem/View.aspx?WorkItemId=26256).

Interestingly if you're at PyCon there will be an open space session tomorrow at 8 which the Jython developers have setup talking about implementation details.  I'll be there for talking about the IronPython side of things.

From: users-bounces at lists.ironpython.com [mailto:users-bounces at lists.ironpython.com] On Behalf Of Tristan Zajonc
Sent: Thursday, February 18, 2010 1:55 PM
To: Discussion of IronPython
Subject: Re: [IronPython] Internals documentation

Dino - Thanks, those links are helpful.

Can I ask how you plan to merge the IronPython and Python documentation?  In terms of using IronPython as a DSL for a specific application, this is an area I've been wondering about.  Pointing users to the official CPython docs doesn't provide the nicest experience for users who aren't interested in the difference between CPython and IronPython and just want to program within an application (resolver one, say).  Perhaps it's unavoidable.

In terms of internals documentation.  Obviously a detailed discussion of programming Python modules would be nice (your links help here).  Perhaps including a discussion of how to write a library that gives a first class experience in both IronPython and the CLR languages.  When should I write a wrapper in Python vs. use attributes, etc, and stay in C# completely?   I'd also be interested in examples of adding new language constructs to IronPython. While perhaps not something you want to encourage, IronPython is appealing as base language for DSLs and showing examples of adding new language features would also show how IronPython works internally. Examples include adding new infix operators (PEP 225 or 211, say) or showing how to implement the with statement.

Tristan

On Thu, Feb 18, 2010 at 3:24 PM, Dino Viehland <dinov at microsoft.com<mailto:dinov at microsoft.com>> wrote:
For the DLR side of things you might find the DLR discussions to be useful: http://dlr.codeplex.com/Thread/List.aspx

This post to the mailing list might also be useful - it covers implementing new modules in .NET for IronPython: http://lists.ironpython.com/pipermail/users-ironpython.com/2009-November/011729.html  That documentation will be included in IronPython once we start including the Python docs + IronPython specific documentation (could be 2.6.1 or 2.6.2).

There's also some useful (although fairly low-level and detailed) information up here: http://ironpython.codeplex.com/wikipage?title=More%20Information such as the exception model and information on value types.

If there's something specific that you'd think helpful let us know - I can probably work to write something up and incorporate it into some documentation.

From: users-bounces at lists.ironpython.com<mailto:users-bounces at lists.ironpython.com> [mailto:users-bounces at lists.ironpython.com<mailto:users-bounces at lists.ironpython.com>] On Behalf Of Tristan Zajonc
Sent: Thursday, February 18, 2010 11:54 AM

To: users at lists.ironpython.com<mailto:users at lists.ironpython.com>
Subject: [IronPython] Internals documentation

Hi,

I'm poking around the IronPython sources and am trying to understand how things works.  I haven't found a good source of documentation that gives an overview of IronPython's internals, and how IronPython can be extended / modified.  I'm looking for more details than are available in books like IronPython in Action, which really only cover the very basics. The best overview I have found is Dino's talk:

http://us.pycon.org/2009/conference/schedule/event/86/

Are there any more reference documents that I can read to get up to speed on IronPython details.

Many thanks,
Tristan

_______________________________________________
Users mailing list
Users at lists.ironpython.com<mailto:Users at lists.ironpython.com>
http://lists.ironpython.com/listinfo.cgi/users-ironpython.com

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ironpython-users/attachments/20100219/0e95007d/attachment.html>