commit: (main branch) Update make-syntax-table doc

[Ben Wing]

changeset:   4945:99e465e2da2e
user:        Ben Wing <ben at xemacs.org>
date:        Sun Jan 24 00:26:10 2010 -0600
files:       lisp/ChangeLog lisp/syntax.el
description:
(main branch) Update make-syntax-table doc

-------------------- ChangeLog entries follow: --------------------

lisp/ChangeLog addition:

2010-01-24  Ben Wing  <ben at xemacs.org>

	* syntax.el:
	* syntax.el (make-syntax-table):
	Expand doc string.


diff -r 6af9b2e79451 -r 99e465e2da2e lisp/ChangeLog
--- a/lisp/ChangeLog	Sat Jan 23 04:45:49 2010 -0600
+++ b/lisp/ChangeLog	Sun Jan 24 00:26:10 2010 -0600
@@ -1,3 +1,9 @@
+2010-01-24  Ben Wing  <ben at xemacs.org>
+
+	* syntax.el:
+	* syntax.el (make-syntax-table):
+	Expand doc string.
+
 2010-01-22  Ben Wing  <ben at xemacs.org>
 
 	* lisp-mode.el:
diff -r 6af9b2e79451 -r 99e465e2da2e lisp/syntax.el
--- a/lisp/syntax.el	Sat Jan 23 04:45:49 2010 -0600
+++ b/lisp/syntax.el	Sun Jan 24 00:26:10 2010 -0600
@@ -2,7 +2,7 @@
 
 ;; Copyright (C) 1993, 1997 Free Software Foundation, Inc.
 ;; Copyright (C) 1995 Sun Microsystems.
-;; Copyright (C) 2005 Ben Wing.
+;; Copyright (C) 2005, 2010 Ben Wing.
 
 ;; This file is part of XEmacs.
 
@@ -36,7 +36,20 @@
 
 (defun make-syntax-table (&optional oldtable)
   "Return a new syntax table.
-It inherits all characters from the standard syntax table."
+
+It inherits all characters from the standard syntax table.
+
+A syntax table is a char table of type `syntax' (see `make-char-table').
+The valid values are integers (intended to be syntax codes as generated by
+`syntax-string-to-code'), and the default result given by `get-char-table'
+is the syntax code for `word'. (Note: In 21.4 and prior, it was the code
+for `inherit'.)
+
+To modify a syntax table, you should normally use `modify-syntax-entry'
+rather than directly modify the table with `put-char-table'.
+
+See `modify-syntax-entry' for a description of the character codes used
+to indicate the various syntax classes."
   (make-char-table 'syntax))
 
 (defun syntax-after (pos)