Post without Account — your post will be reviewed, and if appropriate, posted under Anonymous. You can also use this link to report any problems registering or logging in.

RT 98572 - various cleanup on Content.pm

  • 1 Replies
  • 904 Views
*

Offline Phil

  • Global Moderator
  • Sr. Member
  • *****
  • 437
    • View Profile
RT 98572 - various cleanup on Content.pm
« October 21, 2016, 03:41:58 PM »
Subject:    various cleanup on Content.pm
Date:    Tue, 2 Sep 2014 20:53:38 -0400
To:    bug-PDF-API2 [...] rt.cpan.org
From:    Phil M Perry

PDF:API2  v2.022  Perl 5.16.3  Windows 7  Severity: Normal

  • General cleanup of code, adding spaces to improve readability and () on function arguments
  • In code, regularize argument lists with consistent naming
  • Rearrange order of POD for more logical layout (grouping of functions and their POD descriptions)
  • Enhance POD with fuller descriptions
  • Add methods not described in POD: text_justified() and 4 text_fill_*()
  • Rename private function arctocurve() to _arctocurve()
  • Argument to render() clamp to 0..7 range

There are a number of other internal or private functions that perhaps should also be renamed to start with an underscore _. Is anyone using them? They shouldn't be!

I have submitted a modified Content.pm with these changes to the maintainer.
#
Wed Feb 17 16:30:35 2016 steve [...] deefs.net - Correspondence added

This was too much to review (largely a rewrite of over 2,000 lines of code), so I'm rejecting this.  If you can resubmit the POD updates (not the rearranging, but the improved documentation in-place), that would be handy.
#
Wed Feb 17 16:30:35 2016 The RT System itself - Status changed from 'new' to 'open'
#
Wed Feb 17 16:30:36 2016 steve [...] deefs.net - Status changed from 'open' to 'rejected'
#
Subject:    [rt.cpan.org #98572]
Date:    Thu, 18 Feb 2016 15:43:34 -0500
To:    bug-PDF-API2 [...] rt.cpan.org
From:    Phil M Perry

OK, I'll try to get to it once all the other hits to Content are attended to. I just want to emphasize that it's really important to rearrange the order of entries to make it logically grouped and easy to find something. The current jumble of methods (reflected in the POD) is really haphazard and makes it hard to understand what does what and find information. Would you accept the following?

1. code updates and POD fixes for logged bugs on RT (as separate fixes)
2. code cleanup and POD cleanup (as a number of separate submissions under this bug report)
3. code and POD rearrange into logical order (as the final submission under this bug report)

I could break up #3 into smaller pieces (e.g., moving one method at a time) if that would be acceptable.

*

Offline Phil

  • Global Moderator
  • Sr. Member
  • *****
  • 437
    • View Profile
Re: RT 98572 - various cleanup on Content.pm
« Reply #1: November 14, 2016, 08:46:09 PM »
Added/Fixed in 3.001

Readers of the POD should find the reordering of entries to be a major improvement in readability and logic.