Package: pylint Version: 2.5.3-1 Severity: minor Tags: patch Dear Maintainer,
The patch is based on the current upstream repository. Change a HYPHEN-MINUS (code 0x55, 2D) to a dash (minus), if it shows an option. Reduce space between words. Add a comma after "i.e.". Add a missing roman font for the section of a manual page. Signed-off-by: Bjarni Ingi Gislason <bjarn...@rhi.hi.is> --- man/pyreverse.1 | 55 +++++++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/man/pyreverse.1 b/man/pyreverse.1 index 11631d3d..4c6511c9 100644 --- a/man/pyreverse.1 +++ b/man/pyreverse.1 @@ -5,8 +5,8 @@ them. .SH SYNOPSIS .B pyreverse -.I [options] -<modules> +.RI [ options ] +.RI < modules > .SH DESCRIPTION .B pyreverse @@ -33,71 +33,71 @@ You can do \-c <class1> , \-c <class2>. .SH OPTIONS -.IP "-h, --help" +.IP "\-h, \-\-help" show help message and exit -.IP "-p<name>, --project=<name>" +.IP "\-p<name>, \-\-project=<name>" set project name to <name> if not using \-c option. (default:'No Name') -.IP "--ignore=<file[,file...]>" +.IP "\-\-ignore=<file[,file...]>" add files or directories to the blacklist. They should be base names, not paths. [current: CVS] -.IP "-f<mode>, --filter-mode=<mode>" +.IP "\-f<mode>, \-\-filter-mode=<mode>" filter attributes and functions according to <mode>. You can combine -modes using '+' like 'SPECIAL+OTHER'. Correct modes are : +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 [current: PUB_ONLY] -.IP "-d<file>, --diadefs=<file>" +.IP "\-d<file>, \-\-diadefs=<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] +.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 ancestors and associated classes of <class> and include module names -(i.e. '\-ASmy' ). +(i.e., '\-ASmy' ). -.IP "-a <ancestor>, --show-ancestors=<ancestor>" +.IP "\-a <ancestor>, \-\-show-ancestors=<ancestor>" show <ancestor> generations of ancestor classes not in <projects> -.IP "-A, --all-ancestors=[yn]" +.IP "\-A, \-\-all-ancestors=[yn]" show all ancestors off all classes in <projects> [current: none] -.IP "-s <ass_level>, --show-associated=<associated>" +.IP "\-s <ass_level>, \-\-show-associated=<associated>" show <ass_level> associated classes. <ass_level>=1 will only take classes -directly related to the classes in the project, while <ass_level>=2 +directly related to the classes in the project, while <ass_level>=2 will also take all classes related to those fetched by<depth>=1. -.IP "-S, --all-associated=[yn]" +.IP "\-S, \-\-all-associated=[yn]" show recursively all associated off all associated classes [current: none] -.IP "-b, --builtin" +.IP "\-b, \-\-builtin" include builtin objects in representation of classes [current: False] -.IP "-m [yn], --module-names=[yn]" +.IP "\-m [yn], \-\-module-names=[yn]" include module name in representation of classes. This will include the full module path in the class name. [current: none] -.IP "-k, --only-classnames" +.IP "\-k, \-\-only-classnames" don't show attributes and methods in the class boxes; this disables \-f values [current: False] -.IP "-o <format>, --output=<format>" +.IP "\-o <format>, \-\-output=<format>" create a *.<format> output file if format available. Available formats are all formats that dot can produce and -.B vcg. +.BR vcg . [default: dot] .SH EXAMPLES Here are some examples for command line options: -.IP "pyreverse <project> -a1 -s1 -m" +.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 +diagram of the <project> modules, while \-m will show the full module path of each class. You can use the -.B -a, -s, -A, -S +.B \-a, \-s, \-A, \-S options in the same way. Note that on class diagrams (using -.B -c +.B \-c ) \-a and \-s will rather reduce than enlarge your diagram. -.IP "pyreverse mod/foo.py mod/fee.py -k" +.IP "pyreverse mod/foo.py mod/fee.py \-k" This is interesting if the diagram for <project>=mod is too complicated: you can show only the class names (no attributes or methods, option \-k); @@ -107,7 +107,8 @@ or take only the modules you are interested in (here fee.py and foo.py). Python .SH "SEE ALSO" -.B dot(1), pylint(1) +.BR dot (1), +.BR pylint (1) .I https://www.logilab.org/pyreverse -- 2.27.0 -- System Information: Debian Release: bullseye/sid APT prefers testing APT policy: (500, 'testing'), (500, 'stable') Architecture: amd64 (x86_64) Kernel: Linux 5.7.6-1 (SMP w/2 CPU threads) Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set Shell: /bin/sh linked to /bin/dash Init: sysvinit (via /sbin/init) Versions of packages pylint depends on: ii python3 3.8.2-3 ii python3-astroid 2.4.2-1 ii python3-isort 4.3.4+ds1-2 ii python3-logilab-common 1.7.2-1 ii python3-mccabe 0.6.1-3 ii python3-setuptools 46.1.3-1 ii python3-toml 0.10.1-1 Versions of packages pylint recommends: pn python3-tk <none> Versions of packages pylint suggests: pn pylint-doc <none> -- no debconf information -- Bjarni I. Gislason
