From 88c41dfbdb500e2bdf476ebbad2c82c1bf3ee2e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20Bl=C3=A4ttermann?= Date: Fri, 5 Apr 2019 12:47:33 +0200 Subject: [PATCH 1/3] Add BUGS sections to man pages --- user-docs/man/glabels-batch-qt.rst | 12 ++++++++++++ user-docs/man/glabels-qt.rst | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/user-docs/man/glabels-batch-qt.rst b/user-docs/man/glabels-batch-qt.rst index 0ad6fdd..b343535 100644 --- a/user-docs/man/glabels-batch-qt.rst +++ b/user-docs/man/glabels-batch-qt.rst @@ -79,6 +79,18 @@ FILES Directory for manually created product templates. +BUGS +---- + +To report a bug or make a suggestion regarding this application or this manual +page, you can use the issues section at Github: + + + +It is needed to register/sign in before. In case of you use another locale than +**en** on your system, it would be very helpful for developers if you set the +locale back to American English with the command ``export LC_ALL=C`` before +launching `glabels-qt`. SEE ALSO -------- diff --git a/user-docs/man/glabels-qt.rst b/user-docs/man/glabels-qt.rst index 1c2b152..8edc980 100644 --- a/user-docs/man/glabels-qt.rst +++ b/user-docs/man/glabels-qt.rst @@ -43,6 +43,18 @@ FILES Directory for manually created product templates. +BUGS +---- + +To report a bug or make a suggestion regarding this application or this manual +page, you can use the issues section at Github: + + + +It is needed to register/sign in before. In case of you use another locale than +**en** on your system, it would be very helpful for developers if you set the +locale back to American English with the command ``export LC_ALL=C`` before +launching `glabels-qt`. SEE ALSO -------- From 10518306b85a0f32da65a747d39696901c1696c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20Bl=C3=A4ttermann?= Date: Fri, 5 Apr 2019 15:36:11 +0200 Subject: [PATCH 2/3] Add a more informative short summary for man pages --- user-docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user-docs/conf.py b/user-docs/conf.py index 9535f1f..8b957c5 100644 --- a/user-docs/conf.py +++ b/user-docs/conf.py @@ -149,8 +149,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('man/glabels-qt', 'glabels-qt', 'gLabels Documentation', [author], 1), - ('man/glabels-batch-qt', 'glabels-batch-qt', 'gLabels Documentation', [author], 1) + ('man/glabels-qt', 'glabels-qt', 'create labels and business cards', [author], 1), + ('man/glabels-batch-qt', 'glabels-batch-qt', 'batch creation of labels and business cards', [author], 1) ] From 775a6a7822cf7cbbcb1ac69ea0fad97eed164595 Mon Sep 17 00:00:00 2001 From: Jim Evins Date: Sat, 4 May 2019 14:42:05 -0400 Subject: [PATCH 3/3] Cleaned up english. --- user-docs/_build/man/glabels-batch-qt.1 | 7 +++++-- user-docs/_build/man/glabels-qt.1 | 7 +++++-- user-docs/man/glabels-batch-qt.rst | 10 +--------- user-docs/man/glabels-qt.rst | 9 +-------- 4 files changed, 12 insertions(+), 21 deletions(-) diff --git a/user-docs/_build/man/glabels-batch-qt.1 b/user-docs/_build/man/glabels-batch-qt.1 index 6fa48b5..069178f 100644 --- a/user-docs/_build/man/glabels-batch-qt.1 +++ b/user-docs/_build/man/glabels-batch-qt.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "GLABELS-BATCH-QT" "1" "Dec 29, 2018" "" "gLabels" +.TH "GLABELS-BATCH-QT" "1" "Apr 29, 2019" "" "gLabels" .SH NAME -glabels-batch-qt \- gLabels Documentation +glabels-batch-qt \- batch creation of labels and business cards . .nr rst2man-indent-level 0 . @@ -108,6 +108,9 @@ templates here!\fP .B ${HOME}/.glabels/ Directory for manually created product templates. .UNINDENT +.SH BUGS +.sp +Bugs and featue requests can be reported via the gLabels issue tracking system at GitHub (<\fI\%https://github.com/jimevins/glabels\-qt/issues\fP>). You will need a GitHub account to submit new issues or to comment on existing issues. .SH SEE ALSO .sp \fBglabels\-qt(1)\fP diff --git a/user-docs/_build/man/glabels-qt.1 b/user-docs/_build/man/glabels-qt.1 index 66bd854..d90c351 100644 --- a/user-docs/_build/man/glabels-qt.1 +++ b/user-docs/_build/man/glabels-qt.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "GLABELS-QT" "1" "Dec 29, 2018" "" "gLabels" +.TH "GLABELS-QT" "1" "Apr 29, 2019" "" "gLabels" .SH NAME -glabels-qt \- gLabels Documentation +glabels-qt \- create labels and business cards . .nr rst2man-indent-level 0 . @@ -67,6 +67,9 @@ templates here!\fP .B ${HOME}/.glabels/ Directory for manually created product templates. .UNINDENT +.SH BUGS +.sp +Bugs and featue requests can be reported via the gLabels issue tracking system at GitHub (<\fI\%https://github.com/jimevins/glabels\-qt/issues\fP>). You will need a GitHub account to submit new issues or to comment on existing issues. .SH SEE ALSO .sp \fBglabels\-batch\-qt(1)\fP diff --git a/user-docs/man/glabels-batch-qt.rst b/user-docs/man/glabels-batch-qt.rst index b343535..35dcbce 100644 --- a/user-docs/man/glabels-batch-qt.rst +++ b/user-docs/man/glabels-batch-qt.rst @@ -82,15 +82,7 @@ FILES BUGS ---- -To report a bug or make a suggestion regarding this application or this manual -page, you can use the issues section at Github: - - - -It is needed to register/sign in before. In case of you use another locale than -**en** on your system, it would be very helpful for developers if you set the -locale back to American English with the command ``export LC_ALL=C`` before -launching `glabels-qt`. +Bugs and featue requests can be reported via the gLabels issue tracking system at GitHub (). You will need a GitHub account to submit new issues or to comment on existing issues. SEE ALSO -------- diff --git a/user-docs/man/glabels-qt.rst b/user-docs/man/glabels-qt.rst index 8edc980..33e18d4 100644 --- a/user-docs/man/glabels-qt.rst +++ b/user-docs/man/glabels-qt.rst @@ -46,15 +46,8 @@ FILES BUGS ---- -To report a bug or make a suggestion regarding this application or this manual -page, you can use the issues section at Github: +Bugs and featue requests can be reported via the gLabels issue tracking system at GitHub (). You will need a GitHub account to submit new issues or to comment on existing issues. - - -It is needed to register/sign in before. In case of you use another locale than -**en** on your system, it would be very helpful for developers if you set the -locale back to American English with the command ``export LC_ALL=C`` before -launching `glabels-qt`. SEE ALSO --------