| Summary: | RFC: Notices and slips documentation | ||
|---|---|---|---|
| Product: | Koha | Reporter: | Barton Chittenden <barton> |
| Component: | Developer documentation | Assignee: | Barton Chittenden <barton> |
| Status: | CLOSED WONTFIX | QA Contact: | Testopia <testopia> |
| Severity: | enhancement | ||
| Priority: | P5 - low | ||
| Version: | unspecified | ||
| Hardware: | All | ||
| OS: | All | ||
| See Also: | https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=34472 | ||
| GIT URL: | Initiative type: | --- | |
| Sponsorship status: | --- | Comma delimited list of Sponsors: | |
| Crowdfunding goal: | 0 | Patch complexity: | --- |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: | ||
| Circulation function: | |||
| Attachments: | Bug 21858: RFC: Notices and slips documentation | ||
|
Description
Barton Chittenden
2018-11-18 19:52:51 UTC
Created attachment 82426 [details] [review] Bug 21858: RFC: Notices and slips documentation Koha/Notices.pod documents the following for each notice in the Letter table: * Letter Code * Source file where the notice is populated * Logic that triggers the notice * Detail syntax (if any) * Available data (tables and substitutions) * Message transport restrictions Test plan: Run perldoc Koha/Notices.pod, make sure that the documentation is accurate. Hi Barton, if the idea is a single point of truth, why not require patches to the manual directly? We haven't used POD like that in the past and I am not convinced we should start with another thing to maintain in parallel. We discussed this at a meeting and if I remember correctly we had voted for the manual instead of having a separate file. Closing this as a WONTFIX for now. |