Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

RT Ticket #162: SpecialSub admin_init "documentation" #11

Open
phinjensen opened this Issue Mar 25, 2013 · 0 comments

Comments

Projects
None yet
1 participant
Contributor

phinjensen commented Mar 25, 2013

Created: Sat Feb 16 02:47:45 2008
Requestors: Kevin Walsh


The SpecialSub entry in the docbooks docs was updated with the
following text earlier today:

admin_init —
for users with administrator privileges, event triggered on every
request, after initialization of
embedded Perl objects. This allows &glos-catalog; subroutines to
be specified as request handlers and have properly initialized
&glos-session; variables by the time they run.

Davor,

Where on earth did you get the idea that admin_init allows
subroutines to be specified as request handlers? All the admin_init
subroutine can do is initialise things up ready for the page to
handle the request. The subroutine cannot possibly be described as
a request handler, as any results it tried to return would simply be
ignored.

Why didn't you just use the text on this page?

http://www.interchange.rtfm.info/icdocs/config/SpecialSub.html

I know from the logs that you read the above RTFM page seven minutes
before somehow dreaming up your own version of the text, so perhaps
there's something you misunderstood. Maybe you looked at the
Vend::Dispatch::dispatch() subroutine and thought you saw something
that could possibly justify the text you wrote. I have no idea.

If your pride allowed you to make use of the ever-increasing amount
of existing text then not only would your documentation effort move
forward at a far greater pace but, more importantly, the accuracy
and readability of your text would be massively improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment