texinfo/doc texinfo.txi,1.21,1.22

[karl]

Update of /cvsroot/texinfo/texinfo/doc
In directory sheep:/tmp/cvs-serv1659

Modified Files:
        texinfo.txi 
Log Message:
(ref): mention generating a period, if needed.

Index: texinfo.txi
===================================================================
RCS file: /cvsroot/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.21
retrieving revision 1.22
diff -C2 -d -r1.21 -r1.22
*** texinfo.txi 29 Jan 2004 01:14:05 -0000      1.21
--- texinfo.txi 6 Feb 2004 01:29:02 -0000       1.22
***************
*** 5784,5788 ****
  differently.  @xref{pxref, , @code{@@pxref}}.)@refill
  
! @quotation Note
  A period or comma @strong{must} follow the closing
  brace of an @code{@@xref}.  It is required to terminate the cross
--- 5784,5788 ----
  differently.  @xref{pxref, , @code{@@pxref}}.)@refill
  
! @quotation Caution
  A period or comma @strong{must} follow the closing
  brace of an @code{@@xref}.  It is required to terminate the cross
***************
*** 6235,6250 ****
  
  @quotation Caution
! You @emph{must} write a period or comma immediately after an
! @code{@@ref} command with two or more arguments.  Otherwise, Info will
! not find the end of the cross reference entry and its attempt to
! follow the cross reference will fail.  As a general rule, you should
! write a period or comma after every @code{@@ref} command.  This looks
! best in both the printed and the Info output.  @command{makeinfo}
! warns about any other character.
  @end quotation
  
  
  @node pxref
- @comment  node-name,  next,  previous,  up
  @section @code{@@pxref}
  @cindex Cross references using @code{@@pxref}
--- 6235,6250 ----
  
  @quotation Caution
! You should write a period or comma immediately after an @code{@@ref}
! command with two or more arguments.  Otherwise, Info will generate a
! (grammatically incorrect) period, just so the cross-reference doesn't
! fail completely.
  @end quotation
  
+ As a general rule, you should write a period or comma after every
+ @code{@@ref} command.  This works best in both the printed and the
+ Info output.
+ 
  
  @node pxref
  @section @code{@@pxref}
  @cindex Cross references using @code{@@pxref}
***************
*** 6334,6347 ****
  @code{@@xref} (@pxref{xref, , @code{@@xref}})address@hidden
  
! @quotation Note
  Use @code{@@pxref} only as a parenthetical
  reference.  Do not try to use @code{@@pxref} as a clause in a sentence.
  It will look bad in either the Info file, the printed output, or
  address@hidden
- 
- Also, parenthetical cross references look best at the ends of sentences.
- Although you may write them in the middle of a sentence, that location
- breaks up the flow of address@hidden
  @end quotation
  
  @node inforef
--- 6334,6348 ----
  @code{@@xref} (@pxref{xref, , @code{@@xref}})address@hidden
  
! @quotation Caution
  Use @code{@@pxref} only as a parenthetical
  reference.  Do not try to use @code{@@pxref} as a clause in a sentence.
  It will look bad in either the Info file, the printed output, or
  address@hidden
  @end quotation
+ 
+ Parenthetical cross references look best at the ends of sentences.
+ Although they technically work in the middle of a sentence, that
+ location breaks up the flow of reading.
+ 
  
  @node inforef