Re: GDP: chattiness in @seealso

2007-11-16 Thread Graham Percival
Mats Bengtsson wrote: I'm not sure what the conclusion is, but maybe we can reformulate the original question into: - Should we introduce some new concepts under @seealso or should this always be done in the main text? Let's go with "main text". I'm not completely dead-set on this option, b

Re: GDP: chattiness in @seealso

2007-11-16 Thread Mats Bengtsson
Graham Percival wrote: At the very least, I want it clear which sentence refer to the Notation Reference, and which sentences refer to the other parts of the docs. ... I _really_ think this is completely unnecessary, though. And if you want to add full sentences to every single notation re

Re: GDP: chattiness in @seealso

2007-11-15 Thread Graham Percival
Eyolf Østrem wrote: On 15.11.2007 (16:19), Graham Percival wrote: ... I _really_ think this is completely unnecessary, though. And if you want to add full sentences to every single notation reference @ref{}, I assume you want to do the same for every @lsr{dir,snippet}, every @internalsref

Re: GDP: chattiness in @seealso

2007-11-15 Thread Eyolf Østrem
On 15.11.2007 (16:19), Graham Percival wrote: > > At the very least, I want it clear which sentence refer to the Notation > Reference, and which sentences refer to the other parts of the docs. Agreed. > ... I _really_ think this is completely unnecessary, though. And if you > want to add fu

Re: GDP: chattiness in @seealso

2007-11-15 Thread Eyolf Østrem
On 14.11.2007 (16:18), Graham Percival wrote: > I think we should have a consistent format for the NR; which one do > people prefer? > I have a slight preference against #2 (sentences everywhere), since IMO I know you have, and you know this is the one I prefer. Giving a hint at WHY one shoul

Re: GDP: chattiness in @seealso

2007-11-15 Thread Graham Percival
Eyolf Østrem wrote: On 14.11.2007 (16:18), Graham Percival wrote: I have a slight preference against #2 (sentences everywhere), since IMO I know you have, and you know this is the one I prefer. Giving a hint at WHY one should seealso ain't fluff. This isn't dungeons and dragons ("you are in a

Re: GDP: chattiness in @seealso

2007-11-15 Thread David Fedoruk
Good questions! > > (another overdue discussion question, sorry) IMHO this isn't a problem. The crucial thing to remember is that program documentation isn't for programmers (they have comments in the working code), its for us non-programmers who struggle with programs like lilypond because it req

Re: GDP: chattiness in @seealso

2007-11-15 Thread Valentin Villenave
2007/11/15, Graham Percival <[EMAIL PROTECTED]>: > I have a slight preference against #2 (sentences everywhere), since IMO > in most cases it's obvious why somebody might want to look at other > section. I don't! I like full sentences :) > Option #3 is preferring no explanation at all, but allow

GDP: chattiness in @seealso

2007-11-14 Thread Graham Percival
As always, GDP: http://web.uvic.ca/~gperciva/ (another overdue discussion question, sorry) Take a look at the "see also" sections in NR 1.1.3 Displaying pitches: Instrument transpositions and NR 1.2.1 Writing rhythms: Durations In 1.1.3, we have a short, compact format: No