Opened 12 years ago

Closed 11 years ago

#6793 closed defect (fixed)

dojo.xhr docs need some love

Reported by: Adam Peller Owned by: dylan
Priority: high Milestone: 1.2
Component: General Version: 1.1.0
Keywords: Cc: Neil Roberts, Tom Trenka
Blocked By: Blocking:

Description

some of the ioargs aren't even parsing. "the error function will be called in an error case" -- it might help to describe what an error case is.

Change History (11)

comment:1 Changed 12 years ago by Adam Peller

Cc: Neil Roberts Tom Trenka added

The description that looks like a function is obviously throwing off the parser. Can the doc syntax be such that there is no ambiguity here, or is this a doc parser bug? Also, how would one properly define the function args of the function callbacks here?

comment:2 Changed 12 years ago by Adam Peller

Milestone: 1.2

comment:3 Changed 11 years ago by dylan

(In [14288]) refs #6793, add information about what an error case is for the error handler for xhr

comment:4 Changed 11 years ago by dylan

Owner: changed from anonymous to dylan
Status: newassigned

I've added info. about the error case.

The parsing part of this bug appears to be fixed (though not yet live on api.dojotoolkit.org).

Neil, are the args defined property for the error function?

comment:5 Changed 11 years ago by James Burke

(In [14291]) Refs #6793: Expanded error callback documentation to reflect recent changes to try/catch behavior.

comment:6 Changed 11 years ago by dylan

Resolution: fixed
Status: assignedclosed

comment:7 Changed 11 years ago by Adam Peller

(In [14446]) Add docs for dojo.xhr args. Only problem left is that IOArgs load, error, and handle property docs aren't showing up -- is function signature confusing jsdoc? Refs #6793

comment:8 Changed 11 years ago by Adam Peller

Resolution: fixed
Status: closedreopened

we should probably see this running in api.dtk.org before we close. Also, I think we still need more detail, like information on the callback args (see TODOC)

comment:9 Changed 11 years ago by Adam Peller

(In [14462]) Try to improve wording (please review) and add some TODOCs. Refs #6793

comment:10 Changed 11 years ago by Adam Peller

(In [14463]) oops, put back response arg docs. But can't response be an Error object or structured data? Don't we need to be more descriptive? Is there any point to using the function(...){} syntax, since it's not parsed and only makes this less clear? Refs #6793

comment:11 Changed 11 years ago by dylan

Resolution: fixed
Status: reopenedclosed

Resolved to my satisfaction thanks to Neil's recent work ( see http://api-staging.dojotoolkit.org/dojo.xhr ).

Note: See TracTickets for help on using tickets.