summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorEmile Anclin <emile.anclin@logilab.fr>2008-09-15 14:10:17 +0200
committerEmile Anclin <emile.anclin@logilab.fr>2008-09-15 14:10:17 +0200
commit967fb8be6b4826a6801cce6d77afde52d4b3bf01 (patch)
treea09cf8cd7ee5e3adc03f6151e927c6d29f868f48 /man
parentce593d9639544ffbf17e6cd6717b68573954ee6a (diff)
downloadpylint-967fb8be6b4826a6801cce6d77afde52d4b3bf01.tar.gz
fix #4910: default values are missing in manpage
Diffstat (limited to 'man')
-rw-r--r--man/pylint.1119
1 files changed, 60 insertions, 59 deletions
diff --git a/man/pylint.1 b/man/pylint.1
index 1e58bc5..f053332 100644
--- a/man/pylint.1
+++ b/man/pylint.1
@@ -42,15 +42,15 @@ enable the rpython checker which is disabled by default
.IP "--errors-only, -e"
In debug mode, checkers without error messages are disabled and for others, only the ERROR messages are displayed, and no reports are done by default
.IP "--profile=<y_or_n>"
-Profiled execution. [current: %default]
+Profiled execution. [current: no]
.IP "--ignore=<file>"
-Add <file or directory> to the black list. It should be a base name, not a path. You may set this option multiple times. [current: %default]
+Add <file or directory> to the black list. It should be a base name, not a path. You may set this option multiple times. [current: CVS]
.IP "--persistent=<y_or_n>"
-Pickle collected data for later comparisons. [current: %default]
+Pickle collected data for later comparisons. [current: yes]
.IP "--cache-size=<size>"
-Set the cache size for astng objects. [current: %default]
+Set the cache size for astng objects. [current: 500]
.IP "--load-plugins=<modules>"
-List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers. [current: %default]
+List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers. [current: none]
.SH COMMANDS
.IP "--help-msg=<msg-id>"
@@ -62,11 +62,11 @@ Generate a sample configuration file according to the current configuration. You
.IP "--generate-man"
Generate pylint's man page.
-.SH MESSAGES CONTROL
+.SH MESSAGE CONTROL
.IP "--enable-checker=<checker ids>"
-Enable only checker(s) with the given id(s). This option conflicts with the disable-checker option
+Enable only checker(s) with the given id(s). This option conflicts with the disable-checker option
.IP "--disable-checker=<checker ids>"
-Enable all checker(s) except those with the given id(s). This option conflicts with the enable-checker option
+Enable all checker(s) except those with the given id(s). This option conflicts with the enable-checker option
.IP "--enable-msg-cat=<msg cats>"
Enable all messages in the listed categories.
.IP "--disable-msg-cat=<msg cats>"
@@ -78,17 +78,17 @@ Disable the message(s) with the given id(s).
.SH REPORTS
.IP "--output-format=<format>, -f <format>"
-Set the output format. Available formats are text, parseable, colorized, msvs (visual studio) and html [current: %default]
+Set the output format. Available formats are text, parseable, colorized, msvs (visual studio) and html [current: text]
.IP "--include-ids=<y_or_n>, -i <y_or_n>"
-Include message's id in output [current: %default]
+Include message's id in output [current: no]
.IP "--files-output=<y_or_n>"
-Put messages in a separate file for each module / package specified on the command line instead of printing them on stdout. Reports (if any) will be written in a file name "pylint_global.[txt|html]". [current: %default]
+Put messages in a separate file for each module / package specified on the command line instead of printing them on stdout. Reports (if any) will be written in a file name "pylint_global.[txt|html]". [current: no]
.IP "--reports=<y_or_n>, -r <y_or_n>"
-Tells wether to display a full report or only the messages [current: %default]
+Tells wether to display a full report or only the messages [current: yes]
.IP "--evaluation=<python_expression>"
-Python expression which should return a note less than 10 (10 is the highest note). You have access to the variables errors warning, statement which respectivly contain the number of errors / warnings messages and the total number of statements analyzed. This is used by the global evaluation report (R0004). [current: %default]
+Python expression which should return a note less than 10 (10 is the highest note). You have access to the variables errors warning, statement which respectivly contain the number of errors / warnings messages and the total number of statements analyzed. This is used by the global evaluation report (R0004). [current: 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)]
.IP "--comment=<y_or_n>"
-Add a comment according to your evaluation note. This is used by the global evaluation report (R0004). [current: %default]
+Add a comment according to your evaluation note. This is used by the global evaluation report (R0004). [current: no]
.IP "--enable-report=<rpt ids>"
Enable the report(s) with the given id(s).
.IP "--disable-report=<rpt ids>"
@@ -96,107 +96,108 @@ Disable the report(s) with the given id(s).
.SH BASIC
.IP "--required-attributes=<attributes>"
-Required attributes for module, separated by a comma [current: %default]
+Required attributes for module, separated by a comma [current: none]
.IP "--no-docstring-rgx=<regexp>"
-Regular expression which should only match functions or classes name which do not require a docstring [current: %default]
+Regular expression which should only match functions or classes name which do not require a docstring [current: __.*__]
.IP "--module-rgx=<regexp>"
-Regular expression which should only match correct module names [current: %default]
+Regular expression which should only match correct module names [current: (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$]
.IP "--const-rgx=<regexp>"
-Regular expression which should only match correct module level names [current: %default]
+Regular expression which should only match correct module level names [current: (([A-Z_][A-Z0-9_]*)|(__.*__))$]
.IP "--class-rgx=<regexp>"
-Regular expression which should only match correct class names [current: %default]
+Regular expression which should only match correct class names [current: [A-Z_][a-zA-Z0-9]+$]
.IP "--function-rgx=<regexp>"
-Regular expression which should only match correct function names [current: %default]
+Regular expression which should only match correct function names [current: [a-z_][a-z0-9_]{2,30}$]
.IP "--method-rgx=<regexp>"
-Regular expression which should only match correct method names [current: %default]
+Regular expression which should only match correct method names [current: [a-z_][a-z0-9_]{2,30}$]
.IP "--attr-rgx=<regexp>"
-Regular expression which should only match correct instance attribute names [current: %default]
+Regular expression which should only match correct instance attribute names [current: [a-z_][a-z0-9_]{2,30}$]
.IP "--argument-rgx=<regexp>"
-Regular expression which should only match correct argument names [current: %default]
+Regular expression which should only match correct argument names [current: [a-z_][a-z0-9_]{2,30}]
.IP "--variable-rgx=<regexp>"
-Regular expression which should only match correct variable names [current: %default]
+Regular expression which should only match correct variable names [current: [a-z_][a-z0-9_]{2,30}$]
.IP "--inlinevar-rgx=<regexp>"
-Regular expression which should only match correct list comprehension / generator expression variable names [current: %default]
+Regular expression which should only match correct list comprehension / generator expression variable names [current: [A-Za-z_][A-Za-z0-9_]*$]
.IP "--good-names=<names>"
-Good variable names which should always be accepted, separated by a comma [current: %default]
+Good variable names which should always be accepted, separated by a comma [current: i,j,k,ex,Run,_]
.IP "--bad-names=<names>"
-Bad variable names which should always be refused, separated by a comma [current: %default]
+Bad variable names which should always be refused, separated by a comma [current: foo,bar,baz,toto,tutu,tata ]
.IP "--bad-functions=<builtin function names>"
-List of builtins function names that should not be used, separated by a comma [current: %default]
+List of builtins function names that should not be used, separated by a comma [current: map,filter,apply,input]
.SH CLASSES
.IP "--ignore-iface-methods=<method names>"
-List of interface methods to ignore, separated by a comma. This is used for instance to not check methods defines in Zope's Interface base class. [current: %default]
+List of interface methods to ignore, separated by a comma. This is used for instance to not check methods defines in Zope's Interface base class. [current: isIm plementedBy,deferred,extends,names,namesAndDescription s,queryDescriptionFor,getBases,getDescriptionFor,getDo c,getName,getTaggedValue,getTaggedValueTags,isEqualOrE xtendedBy,setTaggedValue,isImplementedByInstancesOf,ad aptWith,is_implemented_by]
.IP "--defining-attr-methods=<method names>"
-List of method names used to declare (i.e. assign) instance attributes. [current: %default]
+List of method names used to declare (i.e. assign) instance attributes. [current: __init__,__new__,setUp]
.SH DESIGN
.IP "--max-args=<int>"
-Maximum number of arguments for function / method [current: %default]
+Maximum number of arguments for function / method [current: 5]
.IP "--max-locals=<int>"
-Maximum number of locals for function / method body [current: %default]
+Maximum number of locals for function / method body [current: 15]
.IP "--max-returns=<int>"
-Maximum number of return / yield for function / method body [current: %default]
+Maximum number of return / yield for function / method body [current: 6]
.IP "--max-branchs=<int>"
-Maximum number of branch for function / method body [current: %default]
+Maximum number of branch for function / method body [current: 12]
.IP "--max-statements=<int>"
-Maximum number of statements in function / method body [current: %default]
+Maximum number of statements in function / method body [current: 50]
.IP "--max-parents=<num>"
-Maximum number of parents for a class (see R0901). [current: %default]
+Maximum number of parents for a class (see R0901). [current: 7]
.IP "--max-attributes=<num>"
-Maximum number of attributes for a class (see R0902). [current: %default]
+Maximum number of attributes for a class (see R0902). [current: 7]
.IP "--min-public-methods=<num>"
-Minimum number of public methods for a class (see R0903). [current: %default]
+Minimum number of public methods for a class (see R0903). [current: 2]
.IP "--max-public-methods=<num>"
-Maximum number of public methods for a class (see R0904). [current: %default]
+Maximum number of public methods for a class (see R0904). [current: 20]
.SH FORMAT
.IP "--max-line-length=<int>"
-Maximum number of characters on a single line. [current: %default]
+Maximum number of characters on a single line. [current: 80]
.IP "--max-module-lines=<int>"
-Maximum number of lines in a module [current: %default]
+Maximum number of lines in a module [current: 1000]
.IP "--indent-string=<string>"
-String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab). [current: %default]
+String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab).
+ [current: " "]
.SH IMPORTS
.IP "--deprecated-modules=<modules>"
-Deprecated modules which should not be used, separated by a comma [current: %default]
+Deprecated modules which should not be used, separated by a comma [current: regsub,string,TERMIOS,Bastion,rexec]
.IP "--import-graph=<file.dot>"
-Create a graph of every (i.e. internal and external) dependencies in the given file (report R0402 must not be disabled) [current: %default]
+Create a graph of every (i.e. internal and external) dependencies in the given file (report R0402 must not be disabled) [current: none]
.IP "--ext-import-graph=<file.dot>"
-Create a graph of external dependencies in the given file (report R0402 must not be disabled) [current: %default]
+Create a graph of external dependencies in the given file (report R0402 must not be disabled) [current: none]
.IP "--int-import-graph=<file.dot>"
-Create a graph of internal dependencies in the given file (report R0402 must not be disabled) [current: %default]
+Create a graph of internal dependencies in the given file (report R0402 must not be disabled) [current: none]
.SH MISCELLANEOUS
.IP "--notes=<comma separated values>"
-List of note tags to take in consideration, separated by a comma. [current: %default]
+List of note tags to take in consideration, separated by a comma. [current: FIXME,TODO,XXX]
.SH SIMILARITIES
.IP "--min-similarity-lines=<int>"
-Minimum lines number of a similarity. [current: %default]
+Minimum lines number of a similarity. [current: 4]
.IP "--ignore-comments=<y or n>"
-Ignore comments when computing similarities. [current: %default]
+Ignore comments when computing similarities. [current: yes]
.IP "--ignore-docstrings=<y or n>"
-Ignore docstrings when computing similarities. [current: %default]
+Ignore docstrings when computing similarities. [current: yes]
.SH TYPECHECK
.IP "--ignore-mixin-members=<y_or_n>"
-Tells wether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [current: %default]
-.IP "--ignored-classes=<members names>"
-List of classes names for which member attributes should not be checked (useful for classes with attributes dynamicaly set). [current: %default]
+Tells wether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [current: yes]
+.IP "--ignored-classes=<names>"
+List of class names for which member attributes should not be checked (useful for classes with attributes dynamicaly set). [current: SQLObject]
.IP "--zope=<y_or_n>"
-When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes. [current: %default]
-.IP "--acquired-members=<members names>"
-List of members which are usually get through zope's acquisition mecanism and so shouldn't trigger E0201 when accessed (need zope=yes to be considered). [current: %default]
+When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes. [current: no]
+.IP "--generated-members=<members>"
+List of members which are usually get through zope's acquisition mecanism and so shouldn't trigger E0201 when accessed (need zope=yes to be considered). [current: REQUEST,acl_users,aq_parent]
.SH VARIABLES
.IP "--init-import=<y_or_n>"
-Tells wether we should check for unused import in __init__ files. [current: %default]
+Tells wether we should check for unused import in __init__ files. [current: no]
.IP "--dummy-variables-rgx=<regexp>"
-A regular expression matching names used for dummy variables (i.e. not used). [current: %default]
+A regular expression matching names used for dummy variables (i.e. not used). [current: _|dummy]
.IP "--additional-builtins=<comma separated list>"
-List of additional names supposed to be defined in builtins. Remember that you should avoid to define new builtins when possible. [current: %default]
+List of additional names supposed to be defined in builtins. Remember that you should avoid to define new builtins when possible. [current: none]
.SH ENVIRONMENT VARIABLES