From rossini at blindglobe.net  Thu Sep  9 21:14:59 2004
From: rossini at blindglobe.net (A.J. Rossini)
Date: Thu Sep  9 21:14:11 2004
Subject: [Rd] man page of hist points to truehist, which can't be viewed
	without loading a library?
In-Reply-To: <Pine.LNX.4.44.0409091946440.3233-100000@gannet.stats> (Brian
	Ripley's message of "Thu, 9 Sep 2004 19:52:28 +0100 (BST)")
References: <Pine.LNX.4.44.0409091946440.3233-100000@gannet.stats>
Message-ID: <85wtz3gsp8.fsf@servant.blindglobe.net>

Prof Brian Ripley <ripley@stats.ox.ac.uk> writes:

> On Thu, 9 Sep 2004, A.J. Rossini wrote:
>
>> 
>> rdevel from yesterday, also in 1.9.1 (Debian, -3).
>> 
>> The man page of 'hist' (from the graphics package, obtained by
>> "?hist") suggests 'truehist' under "see also", but 'truehist' isn't
>> loaded by default (a sensible "of course"), so that "?truehist" fails.
>> One can do help.search(), of course, which points what to do, but
>> leads to my question:
>> 
>>   In referencing functions in other packages, should the "See Also"
>>   link mention the library that they are coming from?  I'm less
>>   concerned about the example and more concerned about some packages
>>   I'm wrapping up.
>> 
>> (this was from the command line in a terminal window, not w/in ESS).
>
> It is the norm: see e.g. format.Date.Rd or write.table.Rd, and a good 
> idea.

I apologize for not being clear.  It actually does what you describe
in the underlying markup for the help page for "hist".  What I'm
referring to is the display of text, not in the source code which
generates the man page.  i.e.  it would be nice if the markup

   \code{\link[OtherPackage]{relatedFunction}}

generated text such as for example, "relatedFunction (in OtherPackage)".

So to be a bit more explicit, I was wondering whether:

   \code{\link[OtherPackage]{relatedFunction}}  

or

   \code{\link[OtherPackage]{relatedFunction}}  (in OtherPackage)

would be better, stylistically.  I am leaning towards the use of the
latter.  I guess I could submit a patch for the former, not sure if I
can get it done for 2.0 (or if it is even too late).

best,
-tony

-- 
Anthony Rossini			    Research Associate Professor
rossini@u.washington.edu            http://www.analytics.washington.edu/ 
Biomedical and Health Informatics   University of Washington
Biostatistics, SCHARP/HVTN          Fred Hutchinson Cancer Research Center
UW (Tu/Th/F): 206-616-7630 FAX=206-543-3461 | Voicemail is unreliable
FHCRC  (M/W): 206-667-7025 FAX=206-667-4812 | use Email

CONFIDENTIALITY NOTICE: This e-mail message and any attachme...{{dropped}}


[Rd] man page of hist points to truehist, which can't be viewed without loading a library?
A.J. Rossini