diff options
| author | Paul Cochrane <paul@liekut.de> | 2013-11-28 14:57:45 +0100 |
|---|---|---|
| committer | Paul Cochrane <paul@liekut.de> | 2013-11-28 14:57:45 +0100 |
| commit | 9744f157e43c4477a388f946c3116ef7a55f4368 (patch) | |
| tree | a91af5f215d7b1d24fa50ea03cdf178b9a9e5032 /man | |
| parent | d3b3b6c9976960de979b0a92622db3d5729c129a (diff) | |
| download | pylint-git-9744f157e43c4477a388f946c3116ef7a55f4368.tar.gz | |
[man] corrected minor typos and grammatical errors in pyreverse man page
Diffstat (limited to 'man')
| -rw-r--r-- | man/pyreverse.1 | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/man/pyreverse.1 b/man/pyreverse.1 index d37f83d7a..a68ceb56c 100644 --- a/man/pyreverse.1 +++ b/man/pyreverse.1 @@ -10,7 +10,7 @@ them. .SH DESCRIPTION .B pyreverse -is a python source analyzer. It parses a python packages and produces UML +is a python source analyzer. It parses python packages and produces UML diagrams in different output formats. (dot, all formats available for dot, and vcg). With different options, you can have fine tuning on what and how modules, @@ -45,10 +45,10 @@ modes using '+' like 'SPECIAL+OTHER'. Correct modes are : - 'PUB_ONLY' : filter all non public attributes (default) - 'ALL' : no filter - 'SPECIAL' : filter Python special functions except constructor - - 'OTHER' : filter protected and private attributes [currentt: PUB_ONLY] + - 'OTHER' : filter protected and private attributes [current: PUB_ONLY] .IP "-d<file>, --diadefs=<file>" -create diagram according to the diagrams definitions in <file> +create diagram according to the diagram definitions in <file> .IP "-c <class>, --class=<class>" create a class diagram with all classes related to <class> [current: none] the class must be in the file <modules>. By default, this will include all @@ -69,8 +69,8 @@ show recursively all associated off all associated classes [current: none] .IP "-b, --builtin" include builtin objects in representation of classes [current: False] .IP "-m [yn], --module-names=[yn]" -include module name in representation of classes. This will include full -module path in the class name. [current: none] +include module name in representation of classes. This will include the +full module path in the class name. [current: none] .IP "-k, --only-classnames" don't show attributes and methods in the class boxes; @@ -83,15 +83,15 @@ are all formats that dot can produce and [default: dot] .SH EXAMPLES - Here are some examples for command line options : +Here are some examples for command line options: .IP "pyreverse <project> -a1 -s1 -m" \-a1 \-s1 will include one level of ancestor and associated classes in the diagram of the <project> modules, while \-m will show the full module -path of each class. You can use the same way the +path of each class. You can use the .B -a, -s, -A, -S -options. +options in the same way. Note that on class diagrams (using .B -c ) \-a and \-s will rather reduce than enlarge your diagram. |