Skip to main content

Bug Tracker

Side navigation

#5140 closed bug (fixed)

Opened August 29, 2009 05:39PM UTC

Closed February 05, 2010 08:03PM UTC

Some inconsistensies in API documentation xml

Reported by: olav Owned by:
Priority: trivial Milestone:
Component: docs Version:
Keywords: Cc: olav@olav.dk
Blocked by: Blocking:
Description

root/trunk/tools/api-browser/index.xml

Noticed some minor inconsistencies in the API documentation in index.xml

line 1175 (function removeClass, param class) type="String '(optional)' " should probably be a seperate optional="true" attribute

line 1377 (function filter, param expr): Type attribute should probably be "String" (not "Expression"), this is how jQuery-expressions are described other places

line 2136 (function clone, param true): The *name* of the parameter is "true", which is somewhat confusing. In the source it is named "events".

line 2194: (function css, param value) "String or Number" should be "String, Number"

line 2277: (function height, param val) "String or Number" should be "String, Number"

line 3529: (function load, param callback) type="Callback" should probably be type="Function"

Attachments (0)
Change History (1)

Changed February 05, 2010 08:03PM UTC by john comment:1

resolution: → fixed
status: newclosed

Much of this has been resolved in the new API site: http://api.jquery.com/api/