Re: [q-lang-users] Proposed documentation changes
Brought to you by:
agraef
From: Rob H. <hub...@gm...> - 2008-01-22 09:38:27
|
> John Cowan wrote: > > The current structuring of chapters 10, 11, and 12 has more to do > > with where a function is defined and what language it is written in > > (Q or C) than with what it does, so the user ends up having to search > > all three chapters to find things. The Q documentation is excellent. However, I agree that some restructuring based on functionality (rather than implementation or location) would be helpful; so I agree. As it happens, I am now sufficiently familiar with the Q documentation that I can usually find what I'm looking for relatively quickly. However, what John described was certainly a stumbling block for me when I was new to Q. Albert Graef wrote: > That's true, but your proposed reorganization is a lot of work. ;-) I'll > do it eventually, hopefully in time for the 8.0 release. I for one appreciate the difficulty of writing good documentation. I've spent at least twice as long on my documentation as on my Q code, in part as I'm still a LaTeX novice... [I'm still not 100% happy with it.] But, any additional work on the Q documentation will be appreciated. Thanks, Rob. |