From c0d3f6964a537094fa2fff32f0be6e653438b09e Mon Sep 17 00:00:00 2001 From: Michal Nowikowski Date: Fri, 27 Feb 2015 06:48:24 +0100 Subject: Various changes related to docs - added Changelog to docs - added list of contributors to docs - updated CONTRIBUTORS info - slight formating changes in Changelog - updated auto-generated man page and example pylintrc --HG-- branch : docs-improvements2 --- CONTRIBUTORS.txt | 4 ++-- ChangeLog | 38 ++++++++++++++++++++------------------ doc/changelog.rst | 8 ++++++++ doc/index.rst | 3 +++ examples/pylintrc | 13 +++++++++++-- man/pylint.1 | 8 ++++++-- 6 files changed, 50 insertions(+), 24 deletions(-) create mode 100644 doc/changelog.rst diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 108ccbacc..b5d307d99 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -36,8 +36,8 @@ Order doesn't matter (not that much, at least ;) * Carl Crowder: don't evaluate the value of arguments for 'dangerous-default-value' -* Michal Nowikowski: wrong-spelling-in-comment, wrong-spelling-in-docstring and - other patches. +* Michal Nowikowski: wrong-spelling-in-comment, wrong-spelling-in-docstring, + parallel execution on multiple CPUs and other patches. * David Lindquist: logging-format-interpolation warning. diff --git a/ChangeLog b/ChangeLog index ff1b6716d..9977d163e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,7 +1,7 @@ ChangeLog for Pylint -==================== +-------------------- --- +NOT RELEASED YET -- VERSION * Don't require a docstring for empty modules. Closes issue #261. * Fix a false positive with `too-few-format-args` string warning, @@ -477,7 +477,7 @@ ChangeLog for Pylint Golemon * Add new warnings for checking proper class __slots__: - 'invalid-slots-object' and 'invalid-slots'. + `invalid-slots-object` and `invalid-slots`. * Search for rc file in `~/.config/pylintrc` if `~/.pylintrc` doesn't exists (#121) @@ -894,11 +894,11 @@ ChangeLog for Pylint * new W0106 warning 'Expression "%s" is assigned to nothing' * drop E0501 and E0502 messages about wrong source encoding: not anymore - interesting since it's a syntax error for python >= 2.5 and we now only - support this python version and above. + interesting since it's a syntax error for python >= 2.5 and we now only + support this python version and above. - * don't emit W0221 or W0222 when methods as variable arguments (eg *arg - and/or **args). Patch submitted by Charles Duffy. + * don't emit W0221 or W0222 when methods as variable arguments (eg \*arg + and/or \*\*args). Patch submitted by Charles Duffy. @@ -946,13 +946,13 @@ ChangeLog for Pylint * all enable-* / disable-* options have been merged into --enable / --disable * BACKWARD INCOMPATIBLE CHANGE: short name of --errors-only becomes -E, -e being - affected to --enable + affected to --enable * pylint --help output much simplified, with --long-help available to get the - complete one + complete one * revisited gui, thanks to students from Toronto university (they are great - contributors to this release!) + contributors to this release!) * fix #21591: html reporter produces no output if reports is set to 'no' @@ -963,7 +963,7 @@ ChangeLog for Pylint * fix #9018: when using defining-attr-method, method order matters * fix #4595: Comma not followed by a space should not occurs on trailing comma - in list/tuple/dict definition + in list/tuple/dict definition * fix #22585: [Patch] fix man warnings for pyreverse.1 manpage @@ -1093,7 +1093,7 @@ ChangeLog for Pylint * patches by Mads Kiilerich: * implement #4691, make pylint exits with a non zero return - status if any messages other then Information are issued + status if any messages other then Information are issued * fix #3711, #5626 (name resolution bug w/ decorator and class members) @@ -1249,12 +1249,14 @@ ChangeLog for Pylint 2006-08-10 -- 0.12.0 * usability changes: - - parseable, html and color options are now handled by a single - output-format option - - enable- and disable-all options are now handled by - two (exclusive) enable-checker and disable-checker options - taking a comma separated list of checker names as value - - renamed debug-mode option to errors-only + * parseable, html and color options are now handled by a single + output-format option + + * enable- and disable-all options are now handled by + two (exclusive) enable-checker and disable-checker options + taking a comma separated list of checker names as value + + * renamed debug-mode option to errors-only * started a reference user manual diff --git a/doc/changelog.rst b/doc/changelog.rst new file mode 100644 index 000000000..b4a8e3958 --- /dev/null +++ b/doc/changelog.rst @@ -0,0 +1,8 @@ + +Changes & Contributors +====================== + +.. include:: ../ChangeLog + + +.. include:: ../CONTRIBUTORS.txt diff --git a/doc/index.rst b/doc/index.rst index 7b8725c26..01f44c8bc 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -25,6 +25,9 @@ https://bitbucket.org/logilab/pylint backlinks installation + changelog + + Content wanted -------------- diff --git a/examples/pylintrc b/examples/pylintrc index 69f0ee192..9c3a58996 100644 --- a/examples/pylintrc +++ b/examples/pylintrc @@ -30,6 +30,15 @@ symbols=no # Use multiple processes to speed up Pylint. jobs=1 +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + [MESSAGES CONTROL] @@ -51,7 +60,7 @@ confidence= # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" -#disable= +disable=E1608,W1627,E1601,E1603,E1602,E1605,E1604,E1607,E1606,W1621,W1620,W1623,W1622,W1625,W1624,W1609,W1608,W1607,W1606,W1605,W1604,W1603,W1602,W1601,W1639,I0021,W1638,I0020,W1618,W1619,W1630,W1626,W1637,W1634,W1635,W1610,W1611,W1612,W1613,W1614,W1615,W1616,W1617,W1632,W1633,W0704,W1628,W1629,W1636 [REPORTS] @@ -251,7 +260,7 @@ spelling-store-unknown-words=no [FORMAT] # Maximum number of characters on a single line. -max-line-length=80 +max-line-length=100 # Regexp for a line that is allowed to be longer than the limit. ignore-long-lines=^\s*(# )??$ diff --git a/man/pylint.1 b/man/pylint.1 index 3a5c3e978..fd12abb6d 100644 --- a/man/pylint.1 +++ b/man/pylint.1 @@ -1,4 +1,4 @@ -.TH pylint 1 "2014-11-4" pylint +.TH pylint 1 "2015-2-27" pylint .SH NAME .B pylint \- python code static checker @@ -44,6 +44,8 @@ Specify a configuration file. Python code to execute, usually for sys.path manipulation such as pygtk.require(). .IP "--errors-only, -E" In error mode, checkers without error messages are disabled and for others, only the ERROR messages are displayed, and no reports are done by default +.IP "--py3k" +In Python 3 porting mode, all checkers will be disabled and only messages emitted by the porting checker will be displayed .IP "--ignore=[,...]" Add files or directories to the blacklist. They should be base names, not paths. [current: CVS] .IP "--persistent=" @@ -52,6 +54,8 @@ Pickle collected data for later comparisons. [current: yes] List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers. [current: none] .IP "--jobs=, -j " Use multiple processes to speed up Pylint. [current: 1] +.IP "--extension-pkg-whitelist=" +A comma-separated list of package or module names from where C extensions may be loaded. Extensions are loading into the active Python interpreter and may run arbitrary code [current: none] .SH COMMANDS .IP "--help-msg=" @@ -225,7 +229,7 @@ Tells whether to store unknown words to indicated private dictionary in --spelli .SH FORMAT .IP "--max-line-length=" -Maximum number of characters on a single line. [current: 80] +Maximum number of characters on a single line. [current: 100] .IP "--ignore-long-lines=" Regexp for a line that is allowed to be longer than the limit. [current: ^\s*(# )??$] .IP "--single-line-if-stmt=" -- cgit v1.2.1