[Bug 43391] Add POD to all private subroutines/methods
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43391 Tomás Cohen Arazi (tcohen) <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Needs Signoff --- Comment #21 from Tomás Cohen Arazi (tcohen) <tomascohen@gmail.com> --- I'm proposing a counter patchset that replaces the generated placeholder POD with real POD, while keeping the goal of this bug. - Jonathan's xt patch is kept unchanged (it is still his, with David's sign-off). I only added a test plan to the commit message. - The 382 'Missing POD for <sub>.' placeholders are not needed anymore: - 232 private subs get a real description (what they do, parameters, return value, side effects). - _type and object_class get one standard, class-agnostic POD in all Koha::Object(s) classes (452 + 227). Koha::Object and Koha::Objects show it as the form to copy into new classes. - The generated patch also left 139 empty '=head3 type' headings (a typo for '_type' the script did not recognise) and used =head2 everywhere. This is fixed too. - Code is unchanged once POD is stripped, except that in 5 files the constant _type/object_class subs are moved after the last method. IMPORTANT: The new POD is LLM-generated and human-curated. It still needs other human eyes. The commit message lists the entries with complex or surprising behaviour that deserve a careful review. Some possible bugs in the existing code were spotted while writing the POD. The patches describe the current behaviour as-is; the bugs will be reported separately. Back to Needs Signoff, as the content changed. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org