Bug 39887 - Improve documentation of overdue_notices.pl
Summary: Improve documentation of overdue_notices.pl
Status: Pushed to oldstable
Alias: None
Product: Koha
Classification: Unclassified
Component: Command-line Utilities (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low minor
Assignee: Martin Renvoize (ashimema)
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2025-05-13 08:57 UTC by Martin Renvoize (ashimema)
Modified: 2025-06-30 22:46 UTC (History)
4 users (show)

See Also:
GIT URL:
Change sponsored?: ---
Patch complexity: String patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
This improves the help for the misc/cronjobs/overdue_notices.pl script. It tidies the text and clarifies some options, including: - improving the descriptions for the help --test, --date, --email, and --frombranch options - adding some more usage examples (shown when run with the --man option)
Version(s) released in:
25.11.00,25.05.01,24.11.06
Circulation function:


Attachments
Bug 39887: Improve documentation for overdue_notices.pl (7.07 KB, patch)
2025-05-13 09:00 UTC, Martin Renvoize (ashimema)
Details | Diff | Splinter Review
Bug 39887: Improve documentation for overdue_notices.pl (7.07 KB, patch)
2025-05-13 09:02 UTC, Martin Renvoize (ashimema)
Details | Diff | Splinter Review
Bug 39887: Improve documentation for overdue_notices.pl (7.12 KB, patch)
2025-05-23 06:45 UTC, Julian Maurice
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Renvoize (ashimema) 2025-05-13 08:57:30 UTC
The documntation for a few bits of the overdue notices script is a little lacking in places.. I had to read the code to fully understand some parts.
Comment 1 Martin Renvoize (ashimema) 2025-05-13 09:00:13 UTC
Created attachment 182334 [details] [review]
Bug 39887: Improve documentation for overdue_notices.pl

This patch corrects a few spelling mistakes and missing grammer and adds
a little more detail to the '--date', '--email' and '--frombranch'
options.

Signed-off-by: Martin Renvoize <martin.renvoize@openfifth.co.uk>
Comment 2 Martin Renvoize (ashimema) 2025-05-13 09:02:33 UTC
Created attachment 182335 [details] [review]
Bug 39887: Improve documentation for overdue_notices.pl

This patch corrects a few spelling mistakes and missing grammer and adds
a little more detail to the '--date', '--email' and '--frombranch'
options.

Signed-off-by: Martin Renvoize <martin.renvoize@openfifth.co.uk>
Comment 3 Julian Maurice 2025-05-23 06:45:17 UTC
Created attachment 182752 [details] [review]
Bug 39887: Improve documentation for overdue_notices.pl

This patch corrects a few spelling mistakes and missing grammer and adds
a little more detail to the '--date', '--email' and '--frombranch'
options.

Signed-off-by: Martin Renvoize <martin.renvoize@openfifth.co.uk>
Signed-off-by: Julian Maurice <julian.maurice@biblibre.com>
Comment 4 Lucas Gass (lukeg) 2025-06-02 20:58:57 UTC
Nice work everyone!

Pushed to main for 25.11
Comment 5 Fridolin Somers 2025-06-18 13:05:16 UTC
I see in 25.05.x
Comment 6 Fridolin Somers 2025-06-18 13:06:04 UTC
Pushed to 24.11.x for 24.11.06
Comment 7 Paul Derscheid 2025-06-19 09:01:57 UTC
Nice work everyone!

Pushed to 25.05.x for 25.05.03