1) Change \' (acute) to ', if used as an apostrophe.
2) Separate the sentences and subordinate clauses;
each begins on a new line.
See man-pages(7) and "info groff".
The best procedure is to always start a new sentence on a new line,
at least,
if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
3) The section part for a manual page is set in roman font.
Signed-off-by: Bjarni Ingi Gislason <bjarn...@rhi.hi.is>
---
man/epylint.1 | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/man/epylint.1 b/man/epylint.1
index e3df9773..5d3163fa 100644
--- a/man/epylint.1
+++ b/man/epylint.1
@@ -5,10 +5,12 @@
.SH DESCRIPTION
.B epylint
-is an Emacs and Flymake compatible Pylint. It runs Pylint from outside the
-current package to avoid import error messages. See
-.B pylint
-\'s manpage for information about all available options.
+is an Emacs and Flymake compatible Pylint.
+It runs Pylint from outside the
+current package to avoid import error messages.
+See
+.BR pylint 's
+manpage for information about all available options.
.SH "SEE ALSO"
-.B pylint(1)
+.BR pylint (1)
--
2.27.0
_______________________________________________
code-quality mailing list -- code-quality@python.org
To unsubscribe send an email to code-quality-le...@python.org
https://mail.python.org/mailman3/lists/code-quality.python.org/
Member address: arch...@mail-archive.com
