The capitalisation of headerContent when creating a FormOverlay is inconsistent and confusing

Bug #383943 reported by Graham Binns
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Launchpad itself
Won't Fix
High
Unassigned

Bug Description

When creating a FormOverlay you can pass a headerContent variable, which contains the header for the FormOverlay. Every other variable that gets passed when creating a FormOverlay is underscore_delimited, whereas headerContent is camelCapped. This inconsistency is confusing and could lead to unnecessary rage.

Tags: javascript
Paul Hummer (rockstar)
Changed in lazr-js:
status: New → Triaged
importance: Undecided → High
tags: added: trivial
affects: lazr-js → launchpad
Curtis Hovey (sinzui)
tags: added: javascript
removed: trivial
Revision history for this message
Curtis Hovey (sinzui) wrote :

headerContent comes from YUI's WidgetStdMod. To support Launchpad's style, Lp's overlay needs a header_content in ATTRS that also sets headerContent. We may also need to redefine headerContent because anything from YUI's code that sets headerContent also needs to update Lp's header_content.

I doubt we want to do this.

Revision history for this message
Richard Harding (rharding) wrote :

I'm with Curtis. This is a YUI API standard we're working against. We could attempt to wrap it, but the corner cases of keeping values in sync would be more of a pain than it would solve in my opinion.

I think the better solution would be to get YUIDoc running and providing developers with better API documentation that would help make this more obvious.

Changed in launchpad:
status: Triaged → Won't Fix
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.