Re: R-beta: Corrections to documentation

Martin Maechler (maechler@stat.math.ethz.ch)
Mon, 11 May 1998 17:38:01 +0200


Date: Mon, 11 May 1998 17:38:01 +0200
Message-Id: <199805111538.RAA01057@sophie.ethz.ch>
From: Martin Maechler <maechler@stat.math.ethz.ch>
To: Jim Lemon <bitwrit@ozemail.com.au>
Subject: Re: R-beta: Corrections to documentation

>>>>> "Jim" == Jim Lemon <bitwrit@ozemail.com.au> writes:

    Jim> Thanks to Peter Dalgaard's message, I learned a bit more about the
    Jim> 'par' function and rewrote my HTML help file accordingly.

    Jim> Is it appropriate to submit such changes somewhere
    Jim> to improve the documentation?
Of course!
The appropriate place might be simply the R-devel mailing list, unless your
changes are really big.  In that case, you could offer an FTP / HTTP
address where one could get your fix (as *.tar.gz file, if possible).

However, note that you should not edit HTML files which are not the source,
but rather the corresponding  *.Rd files,
	RHOME/src/library/*/man/*.Rd
			  ^
			base
			mva
			eda
			stepfun

from which the HTML, LaTeX, and [nt]roff files are produced automatically.

    Jim> I would also be willing to write some missing documentation as well.

Thank you in advance.

For that and the above (editing an *.Rd file), you probably should read
current "Appendix A", entitled, ``Writing R documentation''
from  RHOME/doc/manual/Man.dvi  (assuming that you got so far...).

-----
For the work you have already done on HTML,
and if you don't have the will to redo in *.Rd,
you can e-mail the output of

	diff -c  file-old.html  file-new.html

to either R-devel or just to me.
Thank you.

Martin Maechler <maechler@stat.math.ethz.ch>			<><
Seminar fuer Statistik, ETH-Zentrum SOL G1;	Sonneggstr.33
ETH (Federal Inst. Technology)	8092 Zurich	SWITZERLAND
phone: x-41-1-632-3408		fax: ...-1086
http://www.stat.math.ethz.ch/~maechler/
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-help-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._