Ticket #2528144 (closed defect)

Reporter


George
Opened: 08/3/09
Last modified: 03/31/10
Status: closed
Type: defect
Resolution: fixed

Owner


Adam Moore
Target Release: 3.1.0
Priority: P3 (normal)
Summary: [bz 2925605] Event.attach/detach documentation is incorrect
Description:

On both http://developer.yahoo.com/yui/3/api/ and the latest event-dom.js on Github,

1) the documentation for Event.detach lists the wrong ordering of arguments. The effect of passing the arguments as described is that the event silently fails to be detached.

And

2) Event.attach doesn't mention that it returns an event handle, instead it claims to return a Boolean.

Type: defect Observed in Version: 3.0.0 Beta1
Component: Event Severity: S3 (normal)
Assigned To: Adam Moore Target Release: 3.1.0
Location: API Documentation Priority: P3 (normal)
Tags: Relates To:
Browsers: N/A
URL:
Test Information:

Change History

Adam Moore

YUI Contributor

Posted: 08/6/09
  • resolution changed to fixed
  • status changed from new to checkedin

API update [fixes #2528144].
View Commit: cf4df02c7a1942475175fe81b993bc1aa268594c

George

YUI Developer

Posted: 03/31/10
  • milestone changed to 3.1.0

George

YUI Developer

Posted: 03/31/10
  • status changed from checkedin to closed