Great, we'll make the changes you suggested and submit a new diff shortly. Side note: we could remove dependancy on 'optik', I'm not even sure pylint > still work with python 2.2 >
On a related note, I was wondering if the FAQ entry on spurious messages when using psyobj should be removed, since it only relates to versions of Pylint before 0.5 - do we want to consider versions of Pylint older than that as no longer supported? -- Team Tahiti On Thu, Apr 1, 2010 at 4:55 AM, Sylvain Thénault < [email protected]> wrote: > On 01 avril 03:59, Colin Morris wrote: > > Hi, > > Hi, > > Attached is a diff of a few documentation improvements that we've been > > working on. Our changes fell under three main areas: > > > > - Expanding and reformatting the FAQ: We found the FAQ extremely > difficult > > to read and navigate, so we reformatted it with the questions as > subheadings > > (this is one of the methods recommended by Docutils, and the method they > use > > in their own FAQ: > > > http://docutils.sourceforge.net/FAQ.html#how-can-i-mark-up-a-faq-or-other-list-of-questions-answers > ). > > In addition, we added some new questions and answers, reflecting our own > > experience with the code, as well as some general information we thought > > that users might find useful. > > great > > > There is some duplication of information between the FAQ and the manual, > > which was not unintentional; however, if you don't think this is > desirable, > > we could try to keep the information in the two documents distinct. > > I think repeatition is usually desirable in documentation > > > One disadvantage we ran into with the reformatting is that, in order to > keep > > the titles on one line (which, as far as we can tell, is necessary), we > had > > to have a few lines that were longer than 80 characters. In as many cases > as > > possible, we tried to reword the questions into more succinct forms, so > this > > only happens a couple times. > > ok, no problem > > > - Copy editing: We tried to fix some occasional odd wording, or typos. > > ok > > > - A table of command line options: with the mass of command line options > and > > features that pylint offers, a new user the command page that we have > added > > when built into the html file will display a table of all of pylints > command > > line options, the arguments they take, and a description of what they are > > used for. A few options have shortcuts which are also displayed in the > > table. > > imo, you should respell 'command' into 'option' in the file name and it's > content. > > Besides this, I'm ok to integrate this good work. > > Side note: we could remove dependancy on 'optik', I'm not even sure pylint > still work with python 2.2. Also, the answer to 'who wrote pylint' should > mention that Logilab has kindly funded most of the pylint development by > paying me and others to do it. > > -- > Sylvain Thénault LOGILAB, Paris (France) > Formations Python, Debian, Méth. Agiles: http://www.logilab.fr/formations > Développement logiciel sur mesure: http://www.logilab.fr/services > CubicWeb, the semantic web framework: http://www.cubicweb.org > >
_______________________________________________ Python-Projects mailing list [email protected] http://lists.logilab.org/mailman/listinfo/python-projects
