[Bug 41634] New: We should add podtidy to our tidying
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Bug ID: 41634 Summary: We should add podtidy to our tidying Initiative type: --- Sponsorship --- status: Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Architecture, internals, and plumbing Assignee: koha-bugs@lists.koha-community.org Reporter: martin.renvoize@openfifth.co.uk QA Contact: testopia@bugs.koha-community.org Depends on: 38664 I've notices a lot of inconsistency in our pod documentation and this leads to poor display in POD display tools. We should add the podtidy tool to our xt scripts and require pod to be tidy the same way we now require everything else to be tidy. Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38664 [Bug 38664] Tidy the whole codebase -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |Trivial patch Status|NEW |Needs Signoff Comma delimited| |Koha Community list of Sponsors| | Sponsorship status|--- |Sponsored -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 --- Comment #1 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Created attachment 191507 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=191507&action=edit feat(tools): Add Pod::Tidy support for consistent POD documentation formatting This implements bug 41634 by integrating Pod::Tidy into Koha's development workflow, similar to how Perl::Tidy handles code formatting. Changes: - Add .podtidyrc configuration file with columns=120 and indent=4 - Update misc/devel/tidy.pl to run podtidy after perltidy on Perl files - Add libpod-tidy-perl to Debian build dependencies - Create xt/podtidy.t test to verify POD formatting - Include .podtidyrc in Makefile.PL distribution manifest Test Plan: 1. Install libpod-tidy-perl dependency 2. Run `./misc/devel/tidy.pl --perl` on Perl files containing POD 3. Verify POD sections are properly formatted (e.g., consistent indentation) 4. Run `prove xt/podtidy.t` to ensure all POD is tidy 5. Commit changes to trigger pre-commit hook which applies tidying automatically Sponsored-by: Koha Community -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Sponsorship status|Sponsored |Unsponsored -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #191507|0 |1 is obsolete| | -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 --- Comment #2 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Created attachment 191508 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=191508&action=edit Bug 41634: Add Pod::Tidy support for consistent POD documentation formatting This integrates Pod::Tidy into Koha's development workflow, similar to how Perl::Tidy handles code formatting. Changes: - Add .podtidyrc configuration file with columns=120 and indent=4 - Update misc/devel/tidy.pl to run podtidy after perltidy on Perl files - Add libpod-tidy-perl to Debian build dependencies - Create xt/podtidy.t test to verify POD formatting - Include .podtidyrc in Makefile.PL distribution manifest Test Plan: 1. Install libpod-tidy-perl dependency 2. Run `./misc/devel/tidy.pl --perl` on Perl files containing POD 3. Verify POD sections are properly formatted (e.g., consistent indentation) 4. Run `prove xt/podtidy.t` to ensure all POD is tidy 5. Commit changes to trigger pre-commit hook which applies tidying automatically -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Comma delimited|Koha Community | list of Sponsors| | -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |martin.renvoize@openfifth.c |ity.org |o.uk -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@gmail.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 --- Comment #3 from Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> --- Hmm.. Pod::Tidy (and podtidy) appears to be rather challenging to get to install now I try.. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 Martin Renvoize (ashimema) <martin.renvoize@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |ASSIGNED -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41634 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david@davidnind.com -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org