PDA

View Full Version : What's the point of having Array documentation



jay@moduscreate.com
12 Oct 2011, 7:14 AM
It's simply cluttering up the docs. When did Sencha decide on documenting JavaScript along with Sencha frameworks?

http://docs-devel.sencha.com/touch/2-0/source/Array.html#

Jamie Avins
12 Oct 2011, 7:59 AM
Wow, someone complains that we have TOO MUCH documentation? Hell hath frozen over!

jay@moduscreate.com
12 Oct 2011, 8:13 AM
I'm not complaining that it's too much, just not "Sencha touch-specific" :).

rdougan
12 Oct 2011, 9:19 AM
I don't think it is a bad thing. I'm sure there are people coming to ST who have very little JavaScript knowledge. :)

jay@moduscreate.com
12 Oct 2011, 10:07 AM
I see where you're coming from. I think historically, JavaScript documentation has not really made its way into Sencha products.

Not to mention that browsing to it might confuse end-users initially because of the duplication. I might be an edge case, but when I view docs, I scroll directly to the methods. Jumping directly to Date breaks that flow. :-\ I now have to pay attention to the icon color and the position of "Date" in the doc tree.

http://moduscreate.com/i/2011-10-12_1406.png

jay@moduscreate.com
12 Oct 2011, 10:08 AM
Perhaps they should be moved to a "JavaScript" subtree.

RWaters
12 Oct 2011, 10:12 AM
Perhaps they should be moved to a "JavaScript" subtree.
+1

edspencer
12 Oct 2011, 11:28 AM
Possibly, or into a guide. Docs are so important and we often overlook complete JS newbies. We have an incredibly exciting secret project coming up to address this better but I think there is value in having the native objects documented in the same place