[Python.NET] Better doc strings.

[Mark McMahon]

Hi Brad,

No idea regarding your coding problem :-/

But your searching problem is easy...
Google allows you to specify a 'site' to restrict searches to. The following will search the archives for "__doc__"
	site:mail.python.org/pipermail/pythondotnet __doc__
(generating this URL)
http://www.google.com.sg/search?q=site%3Amail.python.org%2Fpipermail%2Fpythondotnet%2F+__doc

I guess other search engines may have something similar.

Hope that helps
  Mark


-----Original Message-----
From: pythondotnet-bounces+mark.mcmahon=autodesk.com at python.org [mailto:pythondotnet-bounces+mark.mcmahon=autodesk.com at python.org] On Behalf Of Brad Byrd
Sent: Tuesday, March 29, 2011 1:45 AM
To: pythondotnet at python.org
Subject: [Python.NET] Better doc strings.

I'm trying to provide better documentation for some C# classes that are called from Python.  Ideally, I'd like to markup my class in C#, either with the standard XML comments or with something like a [PythonDocAttribute], and have this documentation show up as the __doc__ string for the method or class in Python.  That way, the clients of my wrapped objects will see nice tool-tips on my classes as they code away in their IDE.

So, is this easily done?  Has anyone else crossed this bridge before?  Does something already exist that would work before I start hacking on the Python.NET source?

(Also, are the archives of the list searchable somewhere?  I just saw clickable-by-month archives, not searchable.)

Thanks,

Brad...

_________________________________________________
Python.NET mailing list - PythonDotNet at python.org http://mail.python.org/mailman/listinfo/pythondotnet