Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#15375 closed defect (fixed)

dijit.form._SearchMixin.onSearch: missing arguments and missing documentation of arguments

Reported by: Adrian Vasiliu Owned by: haysmark
Priority: undecided Milestone: 1.8
Component: Documentation Version:
Keywords: Cc:
Blocked By: Blocking:

Description

The signature of the callback function dijit.form._SearchMixin.onSearch only has a "results" argument and has no description for it, while there are actually 3 arguments passed to the callback function (results, query, and options).

For API documentation purposes, it would be nice to include all three arguments together with their description.

This ticket holds for the current state of trunk. _SearchMixin is new in Dojo 1.8.

Change History (4)

comment:1 Changed 7 years ago by Douglas Hays

Component: Dijit - FormDocumentation
Owner: changed from Douglas Hays to haysmark
Status: newassigned

comment:2 Changed 7 years ago by bill

A few months ago I went through the dijit code cleaning up numerous jslint/jshint errors. I see they are creeping back in now. One commonly reported problem was unused function args. To get around that, rather than:

onSearch: function(/*Object*/ results, query, options){

please do it as a doc comment:

onSearch: function(/*===== results, query, options =====*/){
    // summary:
    //       ...
    // results: Object
    //       ...
...

comment:3 Changed 7 years ago by haysmark

Resolution: fixed
Status: assignedclosed

In [28703]:

Add onSearch API docs. Fixes #15375.

comment:4 Changed 7 years ago by bill

Milestone: tbd1.8
Note: See TracTickets for help on using tickets.