[PyChecker-checkins] CVS: pychecker README,1.32,1.33 index.html,1.38,1.39

[Neal N. <nno...@us...>]

Update of /cvsroot/pychecker/pychecker
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16918

Modified Files:
	README index.html 
Log Message:
add some commonly used flags (i think people will want only)

Index: README
===================================================================
RCS file: /cvsroot/pychecker/pychecker/README,v
retrieving revision 1.32
retrieving revision 1.33
diff -C2 -d -r1.32 -r1.33
*** README	8 Oct 2004 02:28:06 -0000	1.32
--- README	4 Feb 2006 02:15:00 -0000	1.33
***************
*** 55,59 ****
  You can use the test files as examples:
  
! 	pychecker test_input/*.py
  
  If you want to change the default behaviour, you can pass command line options
--- 55,59 ----
  You can use the test files as examples:
  
! 	pychecker [options] test_input/*.py
  
  If you want to change the default behaviour, you can pass command line options
***************
*** 64,67 ****
--- 64,75 ----
  	pychecker -h
  
+ Some of the most common options are:
+ 
+       --only         only warn about files passed on the command line [off]
+   -#, --limit        the maximum number of warnings to be displayed [10]
+   -s, --shadowbuiltin check if a variable shadows a builtin [on]
+   -q, --stdlib       ignore warnings from files under standard library [off]
+   -T, --argsused     unused method/function arguments [on]
+ 
  There is a simple GUI which is not maintained much.  It is good
  for showing all the options and also allows you to run pychecker.

Index: index.html
===================================================================
RCS file: /cvsroot/pychecker/pychecker/index.html,v
retrieving revision 1.38
retrieving revision 1.39
diff -C2 -d -r1.38 -r1.39
*** index.html	8 Oct 2004 02:28:06 -0000	1.38
--- index.html	4 Feb 2006 02:15:00 -0000	1.39
***************
*** 68,75 ****
  <p>
  <pre>
! 	pychecker file1.py file2.py ...
  </pre>
  
  <p>
  Note:  On Windows, use pychecker.bat.  You may also need to add
  python/scripts to your PATH.<br>
--- 68,112 ----
  <p>
  <pre>
! 	pychecker [options] file1.py file2.py ...
  </pre>
  
  <p>
+ Some of the most commonly used options are:
+ <table>
+   <tr><th>Options</th><th>Description</th><th>Default value</th></tr>
+ 
+   <tr>
+     <td>--only</td>
+     <td>only warn about files passed on the command line</td>
+     <td>no</td>
+   </tr>
+ 
+   <tr>
+     <td>-#, --limit</td>
+     <td>the maximum number of warnings to be displayed</td>
+     <td>10</td>
+   </tr>
+ 
+   <tr>
+     <td>--no-shadowbuiltin</td>
+     <td>check if a variable shadows a builtin</td>
+     <td>off</td>
+   </tr>
+ 
+   <tr>
+     <td>-q, --stdlib</td>
+     <td>ignore warnings from files under standard library</td>
+     <td>off</td>
+   </tr>
+ 
+   <tr>
+     <td>-T, --argsused</td>
+     <td>unused method/function arguments</td>
+     <td>on</td>
+   </tr>
+ 
+ </table>
+ 
+ <p>
  Note:  On Windows, use pychecker.bat.  You may also need to add
  python/scripts to your PATH.<br>