[ESS] How does the ess-function-outline-file work?

[Martin Maechler]

>>>>> "PaCo" == Patrick Connolly <p.connolly at hortresearch.co.nz>
>>>>>     on Thu, 7 Jul 2005 21:24:31 +1200 writes:

    PaCo> On Thu, 07-Jul-2005 at 11:18AM +1200, Patrick Connolly
    PaCo> wrote: |> I've used ess-function-outline-file for
    PaCo> years now, and can't remember |> what it needs to work
    PaCo> but it's been great.  Just what is C-f doing

    PaCo> Those who knew what I was referring to will know I
    PaCo> meant "C-c C-f".

I thought I knew what you meant, but 
no longer :-) after this ``correction'' (you mean "C-c f" , right?)

For me,  C-h f  ess-function-outline-file
gives

 > ess-function-outline-file's value is 
 > "/sfs/u/staff/maechler/emacs/ess/etc//function-outline.S"

 > Documentation:
 > The file name of the ess-function outline that is to be inserted at point,
 > when C-c f is used.
 > Placeholders (substituted `at runtime'): $A$ for `Author', $D$ for `Date'.

 > Defined in `essl-s'.

and that help even explains what the file needs to contain...
For me, the file mentioned above has this content :
____________________________________________________________________________

f <- function()
{
  ## Purpose:
  ## ----------------------------------------------------------------------
  ## Arguments:
  ## ----------------------------------------------------------------------
  ## Author: $A$, Date: $D$
}
____________________________________________________________________________


and yes, I use this ``all the time'' and many people in our
statistics group do.

Martin