Branch: refs/heads/blead
  Home:   https://github.com/Perl/perl5
  Commit: 2eb40ee29d736085e63b59883070e31f291b2c4f
      
https://github.com/Perl/perl5/commit/2eb40ee29d736085e63b59883070e31f291b2c4f
  Author: Karl Williamson <[email protected]>
  Date:   2024-09-14 (Sat, 14 Sep 2024)

  Changed paths:
    M autodoc.pl

  Log Message:
  -----------
  autodoc: Fix up comments


  Commit: 9eda6b5b8544ec4cf7f418a5470723dab2a1639f
      
https://github.com/Perl/perl5/commit/9eda6b5b8544ec4cf7f418a5470723dab2a1639f
  Author: Karl Williamson <[email protected]>
  Date:   2024-09-14 (Sat, 14 Sep 2024)

  Changed paths:
    M autodoc.pl

  Log Message:
  -----------
  autodoc: Change loop variable name

The new name is more accurate


  Commit: 9954e3cc8272ff383e19bae5b8b073c693278eaa
      
https://github.com/Perl/perl5/commit/9954e3cc8272ff383e19bae5b8b073c693278eaa
  Author: Karl Williamson <[email protected]>
  Date:   2024-09-14 (Sat, 14 Sep 2024)

  Changed paths:
    M autodoc.pl

  Log Message:
  -----------
  autodoc: Swap the order of conditionals

Get the easier case out of the way first


  Commit: eb0c13af382f0b4c2f6393cfede2bc4d3093b0f4
      
https://github.com/Perl/perl5/commit/eb0c13af382f0b4c2f6393cfede2bc4d3093b0f4
  Author: Karl Williamson <[email protected]>
  Date:   2024-09-14 (Sat, 14 Sep 2024)

  Changed paths:
    M autodoc.pl

  Log Message:
  -----------
  autodoc.pl: Make a header mor complete

This now describes the dictionary ordering of the pod


  Commit: d8645bfd2904ba22c078b7d0b786956858ec7333
      
https://github.com/Perl/perl5/commit/d8645bfd2904ba22c078b7d0b786956858ec7333
  Author: Karl Williamson <[email protected]>
  Date:   2024-09-14 (Sat, 14 Sep 2024)

  Changed paths:
    M autodoc.pl

  Log Message:
  -----------
  autodoc.pl: Add parameter to function

This will be used in the next commit


  Commit: ee948d4b72ec1ec8932e8fadd50ffa9abaa1f655
      
https://github.com/Perl/perl5/commit/ee948d4b72ec1ec8932e8fadd50ffa9abaa1f655
  Author: Karl Williamson <[email protected]>
  Date:   2024-09-14 (Sat, 14 Sep 2024)

  Changed paths:
    M autodoc.pl

  Log Message:
  -----------
  autodoc: Skip outputting an empty list

This is for future extensions, where the list may be empty.


  Commit: a3f1028e12393ecae324d64f4894a5f614788f3e
      
https://github.com/Perl/perl5/commit/a3f1028e12393ecae324d64f4894a5f614788f3e
  Author: Karl Williamson <[email protected]>
  Date:   2024-09-14 (Sat, 14 Sep 2024)

  Changed paths:
    M autodoc.pl

  Log Message:
  -----------
  perlapi/perlintern: Allow alphabetical browsing

It is a lot easier for a user to choose which function to use out of
multiple similar ones when all such are combined into a single group
and the pod compares and contrasts them, highlighting the nuances.  The
alternative is individual functions documented as silos, and the user
has to jump back and and forth between them; the nuances are lost.

The problem is that this grouping can leave the document out of
alphabetical order when the names of related functions don't start with
the same letters.  Someone who is browsing it alphabetically can easily
miss things.

This commit remedies that by creating placeholder entries that are
inserted in alphabetical order and point to the real documentation for
the functions that aren't in alphabetical order.

It turns out that there aren't very many of these.  Though that in part
is because I have avoided combining some alphabetically far-away
functions with their brethern for the very reason that it would make
them hard to find.  Examples include the functions that differ from
others only in that they take an encapsulated argument list and their
names begin with 'v'.  vform() has not been combined with form() and its
kin, but they all really belong together.

This commit means that perlapi/perlintern maintainers no longer have to
consider the sorting effect of their changes.


Compare: https://github.com/Perl/perl5/compare/9c61068521fb...a3f1028e1239

To unsubscribe from these emails, change your notification settings at 
https://github.com/Perl/perl5/settings/notifications

Reply via email to