On ven. 05 avril 2013 00:15:25 CEST, Nicolas Chauvat wrote: > Hi List, > > Now that we have a www.pylint.org, I intend to add a docs.pylint.org. > > I spent a couple hours today collecting existing documentation from > the website and the source tree and merging/refactoring everything > into a sphinx/rst document. > > You can preview it by cloning > http://hg.logilab.org/users/nchauvat/pylint and typing "make html" in > the doc/ subdirectory. > > Early comments are welcome, the docs.pylint.org website should be > available within the next few days. >
Good idea. A few remarks, after building the doc and performing a quick overview: * consistency required between pylint / PyLint / Pylint when refering to the "product". Careful if an attempt to fix this with regexp is made not to break the code samples and commande line examples * Python (the language) should probably be capitalized * output.html : "using the --parseable=y option." -> pylint: error: no such option: --parseable (at least in 0.25 it is --output-format=parseable) * output examples probably need updating (on output.html, there are no column numbers for instance) * extend.html bullet list misformatted ide-integration.html: s/debian/Debian * contribute.html: French and English language must be capitalized Lacking points: * pylint plugins (how to write one, how to install a 3rd party plugin, how to configure Pylint to run it) * pylint brain project : what it is, how to install it... Regards, -- Alexandre _______________________________________________ Python-Projects mailing list Python-Projects@lists.logilab.org http://lists.logilab.org/mailman/listinfo/python-projects
