Thanks for your work Vern! Whether by hand or by decorators, I believe the package-level functions need doc-strings. At least for my purposes, it is important to have documentation for the package-level turtle functions because that it what (my) students use first, and most frequently.
So while I am to leave out the decorators, I really think the documentation still needs to be included. The most direct solution is to cut-and-paste the doc-strings into the package-level functions. That introduces a synchronization issue, plus some people might complain about the readability (although granted it is far less mysterious than the decorators). Or, perhaps, to avoid duplicating doc-strings, a single method could be added that copies the doc-strings from the class methods to the package methods? Then the trickier Python code would not cloud the turtle-code. By the way: do you mean to try to include demo.py in the official distribution? That could be quite helpful, I think, and I would support trying to include it, or more example code in some form. Toby On 4/16/06, Vern Ceder <[EMAIL PROTECTED]> wrote: > Sorry I've been quiet for a while, but in the meantime, I did some final > cleanup and I'm thinking the attached version will be what I'll be > submitting. > > There are some things we've discussed that I decided to leave out, not > necessarily because they shouldn't be done, but because I think we > couldn't get them done in time for the next release of Python. These are: > > 1. The decorator generated docstrings. Cool as the idea was, they make > the source code ugly and would be distracting to newbies actually > reading the code. Besides, in an unscientific survey of Python > developers, the consensus was that decorators were intended for bigger > game. > > 2. any changes to the circle drawing/filling. It clearly doesn't work > right, but fixing it without breaking any old code will take some doing. > > 3. the speed issues addressed a couple weeks ago. Again, it seems like a > good idea, but would involve rewriting several things. > > Otherwise: > > I left the speed() method as taking a string parameter (one of 5 > choices). The delay() method can be used to give finer control. > > I added docstrings to the some utility functions. Thanks to Toby for the > enhanced docstrings everywhere else. > > I've modified one of Gregor's files to serve as a demo and test of both > the old module and the new one. It is attached as demo.py and > enhancements are welcome. > > So have a look and see if you can live with this. Let me know what your > reactions are. > > Cheers, > Vern > -- > This time for sure! > -Bullwinkle J. Moose > ----------------------------- > Vern Ceder, Director of Technology > Canterbury School, 3210 Smith Road, Ft Wayne, IN 46804 > [EMAIL PROTECTED]; 260-436-0746; FAX: 260-436-5137 > > > > > > -- Dr. Toby Donaldson School of Computing Science Simon Fraser University (Surrey) --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "edupython" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/edupython -~----------~----~----~----~------~----~------~--~---
