Opened 14 years ago

Closed 13 years ago

Last modified 12 years ago

#491 closed defect (wontfix)

Documentation is very confusing for events in one place

Reported by: anonymous Owned by: anonymous
Priority: high Milestone:
Component: Doc parser Version: 0.2
Keywords: Cc:
Blocked By: Blocking:

Description

"Normally IE fails to pass the DOM Event object as the first argument to our handler function. Instead, IE forces us to grab the event object from window.event. <<HERE connect() transparently fixes this by ensuring that the event object is passed to our handler as an argument and that it has the standard methods for canceling event bubbling and default behavior. When you use connect(), you can stop writing branching statements in handler functions and focus on handling your event."

Notice on the docs page for event handling: http://dojotoolkit.org/docs/dojo_event_system.html

The words window.event(.)

with a period and:

connect()

get run together such that it looks like:

window.event.connect()

And that is almost impossible for me at least, to read...

Only when I cut and pasted it into this bug report was I able to read it, because of the font variation; so I assume this is due to the font settings used on the doc page. I think it would be much clearer (and this is not an easy subject to grasp for new users as it is) to somehow further qualify connect() instead as dojo.event.connect() and that is much easier to read. And these strings should be separated by some other word like:

.. from window.event. But dojo.event.connect() transparently....

thx.

Change History (3)

comment:1 Changed 14 years ago by anonymous

Milestone: 0.3release
Status: newassigned

comment:2 Changed 13 years ago by anonymous

Resolution: wontfix
Status: assignedclosed

New Documentation system coming that will take care of many of the documentation issues.

comment:3 Changed 12 years ago by (none)

Milestone: 0.3release

Milestone 0.3release deleted

Note: See TracTickets for help on using tickets.