Subject: 23.1; Small typo in doc/lispref/symbols.texi
From: Tim Landscheidt <[email-masked]>
To: [email-masked]
Date: Sat, 08 Oct 2011 14:46:31 +0000
List-Id: <debbugs-submit.debbugs.gnu.org>

Hi,

doc/lispref/symbols.texi in 23.1 and still in (git's) HEAD
bears a small typo (line 538ff.) probably caused by a too
eager search 'n' replace:

| @example
| (plist-get '(foo 4) 'foo)
|      @result{} 4
| (plist-get '(foo 4 bad) 'foo)
|      @result{} 4
| (plist-get '(foo 4 bad) 'bad)
|      @result{} @code{nil}
                 ^^^^^^   ^
| (plist-get '(foo 4 bad) 'bar)
|      @result{} nil
| @end example

which renders as:

|           (plist-get '(foo 4) 'foo)
|                => 4
|           (plist-get '(foo 4 bad) 'foo)
|                => 4
|           (plist-get '(foo 4 bad) 'bad)
|                => `nil'
                    ^   ^
|           (plist-get '(foo 4 bad) 'bar)
|                => nil

To find out whether there were other occurences, I produced
XML output and ran this stylesheet on it:

| <?xml version="1.0"?>

| <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">

|   <xsl:template match="/">
|     <xsl:for-each select="//example[code]">
|       <xsl:copy-of select="."/>
|     </xsl:for-each>
|   </xsl:template>
| </xsl:stylesheet>

This gave another dubious case in lines 834ff. of
doc/lispref/positions.texi:

| @example
| Warning: @code{save-excursion} defeated by @code{set-buffer}
| @end example

I haven't checked the other info files.

  For maintenance purposes, it should be possible to auto-
mate this task (if some document structure is defined).

HTH,
Tim