Re: Another round of docs
- Posted by Dan M. Jul 05, 2008
- 1015 views
I like it! You found/created a nice, intuitive way to have both a long list of routines etc with their "long" descriptions, AND have just a list of routine names which then jump to the long descriptions. Congrats!
I wonder though, if when you get to a "Page Contents", if each of the list of items under the main divisions on such a page really need the full outline sequence of numbers in front of them?
What I mean is, instead of:
4.5.4 File name parsing
4.5.4.1 pathinfo
4.5.4.2 dirname
4.5.4.3 filename
4.5.4.4 filebase
4.5.4.5 fileext
just have:
4.5.4 File name parsing
pathinfo
dirname
filename
filebase
fileext
since each of the items listed won't have any sub items under them.
Reason would be that the sub-numbers don't really add any information value, and sorta obscure the name of the item of interest with the repeated numbers.
Dan
