Re: [Modeling-users] Raw Qualifiers
Status: Abandoned
Brought to you by:
sbigaret
From: Yannick G. <yan...@sa...> - 2003-07-17 13:43:53
|
=2D----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On July 17, 2003 12:33 am, you wrote: > Yannick Gingras <ygi...@yg...> wrote: > > No problem. And as I asked in private why LaTex instead of DocBook ? > > DocBook is a really simple mark up with implied support for unicode > > since it's XML. 30 different tags max in a regular document. KDE, > > Gnome, Python and Linux are all moving to DocBook. I would have put > > it the mark up myself but this LaTex thing is beyond my mere mortal > > capabilities. > > [laziness speaking] I couldn't find a reference for python/docbook, do > you have any? Hummm... it seems that the Python DocBook doc is no-where to be found now... The project was put on hold for some reason... But DocBook is still a nice markup, you can find more info in the on-line version of the ultimate book : http://docbook.sourceforge.net/ or a quick introduction on the Linux Documentation Project : http://tldp.org/LDP/LDP-Author-Guide/usingdocbooktags.html > Why latex? Because I know latex for years and have never tried docbook, > that's as simple. Moreover, I've found the python documentation process, > based on latex, quite handy to generate docs in html/pdf. And well, > before considering a migration, I'd better have a look at docbook > itself. Ok I must admin that since the official Python doc is LaTex and that they supply templates it's a better move to stick with LaTex. > > No the doc is not that bad. This is just a reminder that code is > > meant to be read by both human and computers. Furthermore, a good > > programming language will be more expressive that english. > > [...] > > > The case of the unit tests is really special. The fact that those are > > your quality assurance kit means that they are guaranteed to work. > > There is in those tests an amazing amount of working example and we need > > just that : a picture. I think that the doc should mention them, they > > are more valuable than you think. > > You're probably right. > > However this is already there in the doc, admittedly in little > characters, at http://modeling.sf.net/UserGuide/ec-object-uniquing.html, > I'll see how I can make this more proeminent. You should make it hard to miss it :=20 WARNING WARNING WARNING If you don't read the unit tests, you will miss all the fun ! WARNING WARNING WARNING ; ) =2D --=20 Yannick Gingras Byte Gardener, Savoir-faire Linux inc. (514) 276-5468 =2D----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (GNU/Linux) iD8DBQE/FqgWrhy5Fqn/MRARAjzeAJ9pCJUckayRNJqmtt411IXb9KWNPgCcCyco hXhufOq6PQr+UuWqaBaL7H0=3D =3DUhRs =2D----END PGP SIGNATURE----- |