I'm trying to make sense of some events as they relate to subscribers...

I keep wondering exactly why do the events have different interfaces?

BeforeRender has a dictionary-like interface, whereas NewResponse is 
object-attribute based.

Aside from that -- these docs just aren't resonating with me, and I seem to 
get more and more confused as I read them.

I think the autogenerated sphinx docs are to blame

* If i read the source and see what objects the classes are , that's great. 
 i can even see the attributes.  i know what to expect.
* but the autogenerated docs show the arguments to __init__ instead.  

this is really frustrating.  reading through the docs, i don't really know 
WTF is going on.  

for example:

    class NewResponse(request, response)

i don't know if request & response are classes this inherits from, or 
attributes the object has.  those seem way more likely than being the 2 
args passed to __init__

is there any way it the sphinx docs could read something like 

    class NewResponse(object)
            request = pyramid.request
            response = pyramid.response
        def __init__( request, response ):
        expects a pryamid.request and pyramid.response object on 
instantiation

I just can't imagine why 99% of people would want to see the information 
regarding the pyramid internals  that create the event...

        def __init__( request, response ):
         expects a pryamid.request and pyramid.response object on 
instantiation

The vast majority of people dealing with an event will be consuming the 
class -- not creating it... 

    class NewResponse(object)
            request = pyramid.request
            response = pyramid.response

if the docs cant be configured to generate better stuff - would the 
community be open to a docs patch along these lines?

-- 
You received this message because you are subscribed to the Google Groups 
"pylons-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/pylons-discuss?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to