C++Talk.NET C++ language newsgroups   Archives   FAQ   Search   Memberlist   Usergroups   Register   Profile   Log in to check your private messages   Log in  how to write a tutorial Goto page Previous  1, 2          C++Talk.NET Forum Index -> C Language View previous topic :: View next topic   Author Message Keith Thompson Guest Posted: Wed Jan 26, 2005 9:35 am    Post subject: Re: how to write a tutorial "Xah Lee" <xah (AT) xahlee (DOT) org> writes: [snip] Quote: Following is a tutorial on Python's classes. [snip] Please stop posting this to comp.lang.c. I'm sure the folks in most of the other newsgroup aren't interested either -- or if they are, they can find it in comp.lang.python. Followups redirected. -- Keith Thompson (The_Other_Keith) [email]kst-u (AT) mib (DOT) org[/email] <http://www.ghoti.net/~kst> San Diego Supercomputer Center <*> <http://users.sdsc.edu/~kst> We must do something. This is something. Therefore, we must do this. Back to top Charlton Wilbur Guest Posted: Wed Jan 26, 2005 9:39 am    Post subject: Re: how to write a tutorial Quote: "XL" == Xah Lee <xah (AT) xahlee (DOT) org> writes: XL> I've used the Python tutorial's chapter on class as XL> an example. I've indicated that proper tutorial should be XL> simple, covering just common cases, be self-contained, and be XL> example based. "Correct" is not in your list of criteria. Big surprise, that. Followups set appropriately. Charlton -- cwilbur at chromatico dot net cwilbur at mac dot com Back to top axel@white-eagle.co.uk Guest Posted: Fri Jan 28, 2005 1:48 pm    Post subject: Re: how to write a tutorial In comp.lang.perl.misc Xah Lee <xah (AT) xahlee (DOT) org> wrote: Quote: Following is a tutorial on Python's classes. It is part of a a-Python-a-day mailing list. As an example, it shows what i mean by covering the language's functionalities as is, without needing to chalk up to rocket sciences. If expanded slightly and edited, it can supplant sections 9.0 to 9.4 of the Python tutorial. Languages Tutorials should follow this style. It is crap, not a tutorial, but just an aide-memoire for someone who presumably knows the stuff anyway. And keep it where it belongs please. Axel Back to top Xah Lee Guest Posted: Wed Feb 02, 2005 2:29 pm    Post subject: Re: how to write a tutorial in the doc for re module http://python.org/doc/lib/module-re.html 4.2.2 on Matching vs Searching http://python.org/doc/lib/matching-searching.html Its mentioning of Perl is irrelevant, since the majority reading that page will not have expertise with Perl regex. The whole section should be deleted, because it only adds confusion. (later section 4.2.3 on search and match methods plainly indicated their difference.) (the mentioning of perl there is a combination of author masterbation, ass kissing, and Python fanaticism. All together innocently done as ignorance of standard authors.) A detailed explanation of their difference or the mentioning of Perl should be in FAQ or such material. in section 4.2.6 Examples, there needs to be more and simple examples. (e.g. http://xahlee.org/perl-python/regex.html.) The beginning large section about some scaf() should be deleted for the same reason as the Perl above. ------------------------- in section 11.12.2 SMTP Examples http://python.org/doc/lib/SMTP-example.html the example given is turgid. In a tutorial or documentation, you want to give example as short and to the point as possible. In this case, it is illustrating how to use smtplib, not how to preamble with nice command line interface. A better example would be like: import smtplib smtpServer='smtp.yourdomain.com'; fromAddr='xah (AT) xahlee (DOT) org'; toAddr='xah (AT) xahlee (DOT) org'; text='''Subject: test test Hi ... ''' server = smtplib.SMTP(smtpServer) server.set_debuglevel(1) server.sendmail(fromAddr, toAddr, text) server.quit() Xah [email]xah (AT) xahlee (DOT) org[/email] http://xahlee.org/PageTwo_dir/more.html Back to top        C++Talk.NET Forum Index -> C Language All times are GMT Goto page Previous  1, 2 Page 2 of 2 Powered by phpBB © 2001, 2006 phpBB Group