| Summary: | Improve documentation printed by connexion_import_daemon.pl --help | ||
|---|---|---|---|
| Product: | Koha | Reporter: | Rudolf Byker <rudolfbyker> |
| Component: | Command-line Utilities | Assignee: | Rudolf Byker <rudolfbyker> |
| Status: | Signed Off --- | QA Contact: | Testopia <testopia> |
| Severity: | enhancement | ||
| Priority: | P5 - low | CC: | david, dcook, robin, rudolfbyker |
| Version: | Main | ||
| Hardware: | All | ||
| OS: | All | ||
| Change sponsored?: | Sponsored | Patch complexity: | String patch |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: | ||
| Circulation function: | |||
| Bug Depends on: | |||
| Bug Blocks: | 37539 | ||
| Attachments: |
Improve output of `connexion_import_daemon.pl --help`
Bug 37538: Improve documentation for the OCLC import daemon script. |
||
|
Description
Rudolf Byker
2024-07-31 14:35:36 UTC
Created attachment 169894 [details] [review] Improve output of `connexion_import_daemon.pl --help` Patch attached. Created attachment 169921 [details] [review] Bug 37538: Improve documentation for the OCLC import daemon script. To test: 1) Run `/usr/share/koha/bin/connexion_import_daemon.pl --help` 2) Read the output and check for errors, whether grammatical, spelling, or factual. Sponsored-by: Reformational Study Centre <www.refstudycentre.com> Signed-off-by: David Cook <dcook@prosentient.com.au> Patch works as described. Test plan should use "./misc/bin/connexion_import_daemon.pl --help" rather than "/usr/share/koha/bin/connexion_import_daemon.pl --help" but not a problem I'm not sure that the format is quite inline with other Koha scripts... but it looks like a very useful change. I haven't verified the truth of all the text changes, but they look good at a glance, and much more helpful than the current help text. I'm not sure what you mean by the format not being in line with other scripts. I'm willing to improve it. I'm also willing to just let it go, and eager to get it merged, so that I can refer users to the script's --help output from the manual. (In reply to Rudolf Byker from comment #4) > I'm not sure what you mean by the format not being in line with other > scripts. Say in comparison to the scripts in /usr/sbin/koha-* > I'm willing to improve it. I'm also willing to just let it go, and > eager to get it merged, so that I can refer users to the script's --help > output from the manual. I think that we can just let it go. Honestly, I don't think I have any specific recommendations on how to improve it either. A QAer might have some thoughts on this one, but with a script like this which is so rarely used... I think the more documentation the better in any case. I changed the status to "Needs documenting". Because of the way the Koha workflow is set up in Bugzilla (aimed at changes to the Koha code base), I needed to change the status a few times to get the right status shown: 1. RESOLVED FIXED 2. REOPENED 3. Needs documenting The status can be changed to RESOLVED FIXED once the merge request goes through. (In reply to David Nind from comment #6) > I changed the status to "Needs documenting". > > The status can be changed to RESOLVED FIXED once the merge request goes > through. What needs documenting for this one? Is it just for the release notes or something else? this change shouldn't affect the manual? (In reply to David Cook from comment #7) > (In reply to David Nind from comment #6) > > I changed the status to "Needs documenting". > > > > The status can be changed to RESOLVED FIXED once the merge request goes > > through. > > What needs documenting for this one? Is it just for the release notes or > something else? this change shouldn't affect the manual? OOPS, I updated the wrong bug! (Should have been bug 37539!) Thanks for spotting, David. Have changed back to Signed Off.... |