Opened 10 years ago

Closed 10 years ago

#9503 closed defect (fixed)

error in example from dojo.fx.Toggler api documentation

Reported by: remy damour Owned by: dante
Priority: low Milestone: 1.4
Component: Documentation Version: 1.3.1
Keywords: Cc:
Blocked By: Blocking:

Description

Within api documentation of dojo.fx.Toggler, provided example is reported below:

var t = new dojo.fx.Toggler({
    node: "nodeId",
    showDuration: 500,
    // hideDuration will default to "200"
    showFunc: dojo.wipeIn,
    // hideFunc will default to "fadeOut"
});

Shouldn't 'showFunc' value be dojo.fx.wipeIn rather than dojo.wipeIn ?

Attachments (1)

Screenshot-2.png (27.3 KB) - added by remy damour 10 years ago.
screenshot of potential issue

Download all attachments as: .zip

Change History (6)

Changed 10 years ago by remy damour

Attachment: Screenshot-2.png added

screenshot of potential issue

comment:1 Changed 10 years ago by Eugene Lazutkin

Owner: set to dante

comment:2 Changed 10 years ago by Eugene Lazutkin

(In [18730]) fx: fixing Toggler's docs, !strict, refs #9503.

comment:3 Changed 10 years ago by Eugene Lazutkin

Priority: normallow
severity: normaltrivial

I fixed the bug in question, but the Toggler's inline documentation should be improved:

  • No words on what argument is expected and that it'll be mixed in with the object itself.
  • No words on what options are expected.
  • No words on what various defaults are.

comment:4 Changed 10 years ago by dante

Milestone: tbd1.4

comment:5 Changed 10 years ago by dante

Resolution: fixed
Status: newclosed

in [20144]

Note: See TracTickets for help on using tickets.