Re: read-face-name doc string incorrect

[Nick Roberts]

> The main checking that is needed here is accuracy checking.  Is the
> information correct?  Have the changes in etc/NEWS made it wrong?
> So you need to reread NEWS, then read the text, and check the facts
> it states.

I've looked through etc/NEWS and AFAICS all the significant items have been
updated.  Checking undocumented details can now only really be done by
trawling through the ChangeLogs.  

Many projects have a file called CONTRIBUTE.  I think we should do this also.
There a many things that could go into it, but in particular we could stress
that new features should be documented (or at the least noted in NEWS). 
Perhaps it should be made as a condition of the commit.

I have an observation for display.texi:

You've moved the node "Overlay Arrow" into the node "Fringes" where it says:

      -- Variable: overlay-arrow-string
     ...
     On a graphical display the contents of the string are ignored;

should say:

     If there is a fringe the contents of the string are ignored;

as a graphical display with no fringes will display the string.  This also
means that the variable is somewhat out of place within the node "Fringes".

Of the overlay arrow, you say:

    This feature has nothing to do with "overlays"

but a bit further down it says:

   You can do a similar job by creating an overlay with a `before-string'
   property.

Kim has since added a new node "Fringe Indicators", the overlay arrow in the
fringe being a special case.

Maybe the description of the overlay arrow could be split between the nodes
"Fringe Indicators" and "Overlays".


-- 
Nick                                           http://www.inet.net.nz/~nickrob