Ticket #2531057 (accepted defect)

Reporter


Steven Olmsted
Opened: 09/6/11
Last modified: 09/19/12
Status: accepted
Type: defect

Owner


Luke Smith
Target Release: BACKLOG
Priority: P3 (normal)
Summary: emitFacade documentation is ambiguous
Description:

In at least three places, the documentation says that a custom event's emitFacade property defaults to false.

They are here.
Attribute's API - http://yuilibrary.com/yui/docs/api/classes/Attribute.html#method_publish
EventTarget's API - http://yuilibrary.com/yui/docs/api/classes/EventTarget.html#method_publish
EventTarget's User Guide - http://yuilibrary.com/yui/docs/event-custom/#configs

There is one sentence in EventTarget's User Guide which explains that emitFacade is set to true for you.
http://yuilibrary.com/yui/docs/event-custom/#facade

Technically, it is true that emitFacade defaults to false, but for the most common cases of augmenting Y.Attribute or extending Y.Base it will default to true. This should be documented better in the
API. I was not setting emitFacade and expecting it's value to be false. I had to go looking through the source to figure out why it was defaulting to true.

Attribute sets the default on its instance of EventTarget.
http://yuilibrary.com/yui/docs/api/files/attribute_js_Attribute.js.html#l94

Type: defect Observed in Version: 3.4.0
Component: Event Severity: S3 (normal)
Assigned To: Luke Smith Target Release: BACKLOG
Location: API Documentation Priority: P3 (normal)
Tags: api,Attribute,Base,custom,documentation,emitFacade,event,EventTarget,facade,publish Relates To:
Browsers: N/A
URL:
Test Information:

Change History

Luke Smith

YUI Contributor

Posted: 09/26/11
  • location changed to API Documentation
  • milestone changed to 3.5.0
  • priority changed to P3 (normal)
  • status changed from new to accepted

Luke Smith

YUI Contributor

Posted: 11/9/11
  • milestone changed from 3.5.0 to 3.NEXT

Bug scrub. Moving to 3.NEXT with the intention to pull into 3.6.0. 3.5.0 is all DataTable for me, so I can't afford the split bandwidth.

Jenny Donnelly

YUI Developer

Posted: 09/19/12
  • milestone changed from 3.NEXT to BACKLOG

Moving from 3.NEXT to BACKLOG.