Bug 26907 - Fix POD for C4::Auth::checkauth
Summary: Fix POD for C4::Auth::checkauth
Status: NEW
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low minor (vote)
Assignee: Bugs List
QA Contact: Testopia
Depends on:
Reported: 2020-11-03 13:06 UTC by Magnus Enger
Modified: 2020-11-03 13:06 UTC (History)
0 users

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Note You need to log in before you can comment on or make changes to this bug.
Description Magnus Enger 2020-11-03 13:06:14 UTC
Multiple problems here:

- There are several "private" subroutines (starting with underscore) between the POD and the actual checkauth subroutine, so if you search for "sub checkauth" you might miss that the POD is actually there (I did).

- The example of how to use the sub is:
($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
but the sub is actually looking for more possible arguments:
 793     my $authnotrequired = shift;
 794     my $flagsrequired   = shift;
 795     my $type            = shift;
 796     my $emailaddress    = shift;
 797     my $template_name   = shift;

- The POD says "The login page is provided using a HTML::Template". As far as I know that would now be TT, HTML::Template.