[Closed] Missing and/or incorrect API Docs (1.0-1.0.1)

[jbowman]

getSortState
public function getSortState()
Returns the sort state of the Store as an object with two properties:


field {String} The name of the field by which the Records are sorted
dir {String} The sotr order, "ASC" or "DESC"

Parameters:

* None.

Returns:

* void

This method is defined by Store.

should be

getSortState
public function getSortState()
Returns the sort state of the Store as an object with two properties:


field {String} The name of the field by which the Records are sorted
direction {String} The sort order, "ASC" or "DESC"

Parameters:

* None.

Returns:

* void

This method is defined by Store.

[brian.moeskau]

Fixed in SVN. Thanks!

[KimH]

The "This would consume an XML file like this:" has a <pre>...</pre> with the XML inside. But the XML is non escaped.

[Animal]

Fixed in SVN.

[efege]

Here is a list of occurrences of it's which should be replaced by its:

BasicForm.js
* does NOT remove it's markup

Combo.js
* Select an item in the dropdown list by it's data value
* Select an item in the dropdown list by it's numeric index

Component.js
* render it to it's container element

DropZone.js
* but not over any of it's registered drop nodes.
* but not on any of it's registered drop nodes.

Fx.js
* and then collapses on it's center

Menu.js
* relative to it's element of origin

StatusProxy.js
* Force the Layer to sync it's shadow and shim positions
* Causes the proxy to return to it's position of origin

TextField.js
* grow and shrink to it's content


And here we have double quotes instead of apostrophes:

DateField.js
* if it"s blank and textfield didn"t flag it

NumberField.js
* if it"s blank and textfield didn"t flag it

[jay@moduscreate.com]

EventObject example:
"fu<>nction"

[efege]

More.

Element.js
* @ return => @return (3 times)
* retreive => retrieve (2 times)
* prevent's => prevents

[Animal]

Bravo efege! Another techie who knows the correct usage of "it's" (Apostrophe standing in for a missing "i"), and "its" (Just another possesive pronoun like "his" and "hers")

We'll be using "you're" and "your" correctly next!

[efege]

Thanks Animal. And don't forget seperate.

In fact, I'm always surprised that programmers systematically make those mistakes (it's, seperate, you're), since they are people who necessarily pay high attention to language details. These errors are a source of distraction while reading, and IMO that's a good reason to try to avoid them.

Well, today I found 3 real typos:

Fx.js
* provde => provide
* that will server => that will serve

TextMetrics.js
* nased => based

[rtannert2]

And four cases of "its" that should be "it's":

Date.js, line 36: Whether its a leap year
Tree.js, line 361: its a move, make sure we move it cleanly
UpdateManager.js, line 237: ... it assumes its a file upload.
UpdateManager.js, 482: This is called when the transaction is completed and its time to update the element

I was pleasantly surprised to find only eleven misuses of "it's" and only four of "its" in all of the inline documentation. Great job, guys!

Rob