Bug 1170 : Description text should appear first after the method name, not below "examples"; add next/previous links for browsing the reference
Last modified: 2009-02-26 18:55




Status:
RESOLVED 		Resolution:
LATER - 		Priority:
P2 		Severity:
normal

 

Reporter:
jyoull 		Assigned To:
REAS

Attachment Type Created Size Actions
Example of one way to reorganize the reference page as described in 1170 image/png 2009-02-23 05:27 34.12 KB

Description:   Opened: 2009-02-23 05:14
Some programmers (myself included) get acquainted with a new programming
language by browsing through the reference. By convention, language
references show method or function names, and then their textual
descriptions, before getting into the specifics of using the methods, their
parameters, or related / see-also items.

The reference would better help new learners if the descriptive text were
moved up.

Additionally, the reference is not presently browse-able, requiring a BACK
click to check out the next function. This makes it very difficult for a
newcomer to survey the language. Considering that methods are already
grouped by category, browsing seems to have been anticipated, but is not
implemented. Adding NEXT and PREV links within the language reference will
fix this.
Additional Comment #1 From jyoull 2009-02-23 05:27
edit]
Example of one way to reorganize the reference page as described in 1170
Additional Comment #2 From REAS 2009-02-26 18:55
Thank you for the suggestion. We'll take this into consideration when we
re-evaluate the reference.