interchange / xmldocs

Interchange new documentation (XML source)
http://www.icdevgroup.org/
4 stars 3 forks source link

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

Open phinjensen opened 11 years ago

phinjensen commented 11 years ago

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.