|
From: | Graham Percival |
Subject: | Re: GDP: chattiness in @seealso |
Date: | Thu, 15 Nov 2007 16:50:21 -0800 |
User-agent: | Thunderbird 2.0.0.6 (X11/20071022) |
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{}, etc ?No, not really. My only concern -- since you asked for general principles -- is that there shouldn't be a rule to preclude explanation where it is desirable.
That's why I proposed #3 -- short explanations could be added if needed, but most of the time you wouldn't need any explanation. To take the current examples, if you're looking at Durations and see a link to "writing rests" (or simply "rests", which is what we should have there), I don't think there's any question about why it might be useful.
Also, remember that this is the format inside the @seealso -- not about having links in the main doc section.
Cheers, - Graham
[Prev in Thread] | Current Thread | [Next in Thread] |