[elpa] 01/01: * doc/chess.texi (The "next" position): Actually add `chess-ply-next-pos'. * chess-ply.el (chess-ply-next-pos): Add docstring.

[Mario Lang]

mlang pushed a commit to branch externals/chess
in repository elpa.

commit 622d49a3fc57fba412e5f9737eb5594ffaf0aac4
Author: Mario Lang <address@hidden>
Date:   Thu Jun 5 01:24:53 2014 +0200

    * doc/chess.texi (The "next" position): Actually add `chess-ply-next-pos'.
    * chess-ply.el (chess-ply-next-pos): Add docstring.
---
 ChangeLog      |    4 ++
 chess-ply.el   |    1 +
 chess.info     |  102 +++++++++++++++++++++++++++++---------------------------
 doc/chess.texi |   17 ++++++---
 4 files changed, 69 insertions(+), 55 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 91b0ff8..752735a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2014-06-05  Mario Lang  <address@hidden>
 
+       * doc/chess.texi (The "next" position): Actually add 
`chess-ply-next-pos'.
+
+       * chess-ply.el (chess-ply-next-pos): Add docstring.
+
        * doc/chess.texi (Position coordinates): Document `chess-next-index'
        and related constants.
        (The sought game display): Update as the mentioned mode name has 
changed.
diff --git a/chess-ply.el b/chess-ply.el
index 26a832c..298644c 100644
--- a/chess-ply.el
+++ b/chess-ply.el
@@ -131,6 +131,7 @@
         (cadr changes))))
 
 (defsubst chess-ply-next-pos (ply)
+  "Return the position that results from executing PLY."
   (cl-assert (listp ply))
   (or (chess-ply-keyword ply :next-pos)
       (let ((position (apply 'chess-pos-move
diff --git a/chess.info b/chess.info
index 9fb7196..4477978 100644
--- a/chess.info
+++ b/chess.info
@@ -542,6 +542,9 @@ File: chess.info,  Node: The "next" position,  Next: 
Algebraic notation,  Prev:
 1.2.3 The "next" position
 -------------------------
 
+ -- Function: chess-ply-next-pos ply
+     Return the position that results from executing PLY.
+
  -- Function: chess-ply-final-p ply
      Return non-nil if this is the last ply of a game/variation.
 
@@ -691,10 +694,10 @@ variations.
      Add to GAME an event hook FUNCTION.
 
  -- Function: chess-game-add-ply game ply
-     Return the position related to GAME's INDEX position.
+     Add PLY to the main variation of GAME.
 
  -- Function: chess-game-hooks game
-     Return the tags alist associated with GAME.
+     Return the event hooks associated with GAME.
 
  -- Function: chess-game-plies game
      Return the main variation of GAME as a list of plies.
@@ -707,7 +710,7 @@ variations.
      Run the event hooks of GAME and pass ARGS.
 
  -- Function: chess-game-set-hooks game hooks
-     Return the tags alist associated with GAME.
+     Set the event hooks associated with GAME.
 
  -- Function: chess-game-set-plies game plies
      Set the list of plies which represents the main variation of GAME.
@@ -768,11 +771,11 @@ File: chess.info,  Node: Game positions,  Next: Game 
plies,  Prev: Game tags,  U
      Return the GAME's current position index.
 
  -- Function: chess-game-seq game
-     Return the current GAME sequence.
+     Return the current GAME sequence number.
 
  -- Function: chess-game-side-to-move game &optional index
      Return the color whose move it is in GAME at INDEX (or at the last
-     position if INDEX is nil).
+     position if INDEX is nil).  't' for white and 'nil' for black.
 
 
 File: chess.info,  Node: Game plies,  Next: Making a move,  Prev: Game 
positions,  Up: Games
@@ -803,11 +806,11 @@ File: chess.info,  Node: PGN notation,  Prev: Making a 
move,  Up: Games
 ------------------
 
  -- Function: chess-pgn-to-game &optional string
-     Convert PGN notation at point into a chess game.  Optionally use
+     Convert "PGN notation" at point into a chess game.  Optionally use
      the supplied STRING instead of the current buffer.
 
  -- Function: chess-game-to-pgn game &optional indented to-string
-     Convert a chess GAME to PGN notation.  If INDENTED is non-nil,
+     Convert a chess GAME to "PGN notation".  If INDENTED is non-nil,
      indent the move texts.  If TO-STRING is non-nil, return a string
      instead of inserting the resulting PGN text.
 
@@ -1480,7 +1483,8 @@ Function and Variable Index
 * chess-plain-white-square-char:         Plain ASCII diagram displays.
                                                                (line 22)
 * chess-ply-create:                      Creating plies.       (line  6)
-* chess-ply-final-p:                     The "next" position.  (line  6)
+* chess-ply-final-p:                     The "next" position.  (line  9)
+* chess-ply-next-pos:                    The "next" position.  (line  6)
 * chess-ply-pos:                         Ply details.          (line  6)
 * chess-ply-set-pos:                     Ply details.          (line  9)
 * chess-ply-source:                      Ply details.          (line 12)
@@ -1551,46 +1555,46 @@ Node: Plies16994
 Node: Creating plies18185
 Node: Ply details19369
 Node: The "next" position19849
-Node: Algebraic notation20111
-Node: Variations21539
-Node: Creating variations22667
-Node: Variation positions22975
-Node: Varation plies23576
-Node: Making a move in a variation24017
-Node: Games24592
-Node: Creating games26278
-Node: Game tags26719
-Node: Game positions27326
-Node: Game plies27907
-Node: Making a move28176
-Node: PGN notation28603
-Node: PGN mode29353
-Node: Collections29614
-Node: Opening Databases30415
-Node: Querying Databases30799
-Node: Modifying Databases31425
-Node: Finalising Databases31697
-Node: Database Modules31872
-Node: chess-file32166
-Node: chess-scid32808
-Node: Modules33045
-Node: Chessboard displays39794
-Node: Generic display manipulation functions40422
-Node: Plain ASCII diagram displays43347
-Node: ICS1 style ASCII displays44792
-Node: Graphical displays45096
-Node: Engines45250
-Node: Common functions45828
-Node: Crafty46868
-Node: Gnu Chess46983
-Node: Phalanx47095
-Node: Sjeng47202
-Node: Internet Chess Servers47287
-Node: Connecting to a server48206
-Node: Seeking an opponent for a new game48882
-Node: The sought game display49334
-Node: Concept Index50310
-Node: Function and Variable Index50553
-Node: Key Index61752
+Node: Algebraic notation20207
+Node: Variations21635
+Node: Creating variations22763
+Node: Variation positions23071
+Node: Varation plies23672
+Node: Making a move in a variation24113
+Node: Games24688
+Node: Creating games26358
+Node: Game tags26799
+Node: Game positions27406
+Node: Game plies28030
+Node: Making a move28299
+Node: PGN notation28726
+Node: PGN mode29480
+Node: Collections29741
+Node: Opening Databases30542
+Node: Querying Databases30926
+Node: Modifying Databases31552
+Node: Finalising Databases31824
+Node: Database Modules31999
+Node: chess-file32293
+Node: chess-scid32935
+Node: Modules33172
+Node: Chessboard displays39921
+Node: Generic display manipulation functions40549
+Node: Plain ASCII diagram displays43474
+Node: ICS1 style ASCII displays44919
+Node: Graphical displays45223
+Node: Engines45377
+Node: Common functions45955
+Node: Crafty46995
+Node: Gnu Chess47110
+Node: Phalanx47222
+Node: Sjeng47329
+Node: Internet Chess Servers47414
+Node: Connecting to a server48333
+Node: Seeking an opponent for a new game49009
+Node: The sought game display49461
+Node: Concept Index50437
+Node: Function and Variable Index50680
+Node: Key Index61952
 
 End Tag Table
diff --git a/doc/chess.texi b/doc/chess.texi
index f9effd8..0e6fa8b 100644
--- a/doc/chess.texi
+++ b/doc/chess.texi
@@ -662,6 +662,10 @@ Returns the target square index value of @var{ply}.
 
 @c lispfun chess-ply-next-pos
 
address@hidden chess-ply-next-pos ply
+Return the position that results from executing @var{ply}.
address@hidden defun
+
 @c lispfun chess-ply-final-p
 
 @defun chess-ply-final-p ply
@@ -837,13 +841,13 @@ Add to @var{game} an event hook @var{function}.
 @c lispfun chess-game-add-ply
 
 @defun chess-game-add-ply game ply
-Return the position related to @var{game}'s @var{index} position.
+Add @var{ply} to the main variation of @var{game}.
 @end defun
 
 @c lispfun chess-game-hooks
 
 @defun chess-game-hooks game
-Return the tags alist associated with @var{game}.
+Return the event hooks associated with @var{game}.
 @end defun
 
 @c lispfun chess-game-plies
@@ -869,7 +873,7 @@ Run the event hooks of @var{game} and pass @var{args}.
 @c lispfun chess-game-set-hooks
 
 @defun chess-game-set-hooks game hooks
-Return the tags alist associated with @var{game}.
+Set the event hooks associated with @var{game}.
 @end defun
 
 @c lispfun chess-game-set-plies
@@ -952,7 +956,7 @@ Return the @var{game}'s current position index.
 @c lispfun chess-game-seq
 
 @defun chess-game-seq game
-Return the current @var{game} sequence.
+Return the current @var{game} sequence number.
 @end defun
 
 @c lispfun chess-game-side-to-move
@@ -960,6 +964,7 @@ Return the current @var{game} sequence.
 @defun chess-game-side-to-move game &optional index
 Return the color whose move it is in @var{game} at @var{index} (or at the last 
position
 if @var{index} is nil).
address@hidden for white and @code{nil} for black.
 @end defun
 
 @node Game plies, Making a move, Game positions, Games
@@ -990,14 +995,14 @@ progress (nil), if it is drawn, resigned, mate, etc.
 @c lispfun chess-pgn-to-game
 
 @defun chess-pgn-to-game &optional string
-Convert @var{pgn} notation at point into a chess game.
+Convert @dfn{PGN notation} at point into a chess game.
 Optionally use the supplied @var{string} instead of the current buffer.
 @end defun
 
 @c lispfun chess-game-to-pgn
 
 @defun chess-game-to-pgn game &optional indented to-string
-Convert a chess @var{game} to @var{pgn} notation.
+Convert a chess @var{game} to @dfn{PGN notation}.
 If @var{indented} is non-nil, indent the move texts.
 If @var{to-string} is non-nil, return a string instead of inserting the 
resulting
 @var{pgn} text.