Fix typos.

* emacs-lisp/chart.el, emacs-lisp/eieio.el, emacs-lisp/eieio-base.el
* emacs-lisp/eieio-comp.el, emacs-lisp/eieio-custom.el
* emacs-lisp/eieio-datadebug.el, emacs-lisp/eieio-opt.el
* emacs-lisp/eieio-speedbar.el

lisp/ChangeLog

+2009-10-05  Juanma Barranquero  <lekktu@gmail.com>
+
+	* emacs-lisp/chart.el (chart-face-pixmap-list, chart-new-buffer, chart)
+	(chart-axis-range, chart-axis-names, chart-sequece, chart-bar)
+	(chart-draw, chart-axis-draw, chart-sort, chart-sort-matchlist)
+	(chart-draw-line, chart-bar-quickie): Fix typos in docstrings.
+
+	* emacs-lisp/eieio.el (generic-p, eieiomt-next, eieio-generic-form)
+	(eieio-default-superclass): Reflow docstrings.
+	(this, class-option-assoc, defclass, eieio-class-un-autoload)
+	(eieio-unbind-method-implementations, defmethod)
+	(eieio-validate-slot-value, eieio-validate-class-slot-value)
+	(oref-default, eieio-oref-default, eieio-oset, eieio-oset-default)
+	(with-slots, eieio-add-new-slot, object-assoc, object-remove-from-list)
+	(eieio-slot-originating-class-p, eieio-slot-name-index)
+	(eieio-pre-method-execution-hooks, eieio-initarg-to-attribute)
+	(constructor, initialize-instance, no-next-method, object-print)
+	(object-write, eieio-override-prin1, eieio-edebug-prin1-to-string):
+	Fix typos in docstrings.
+	(eieio-defclass, eieio-perform-slot-validation-for-default, defgeneric)
+	(child-of-class-p, object-slots, slot-boundp, slot-exists-p)
+	(next-method-p): Doc fixes.
+	(eieio-add-new-slot, call-next-method, eieiomt-add, change-class):
+	Fix typos in error messages.
+	(eieio-defmethod): Fix typo in description of generic method.
+
+	* emacs-lisp/eieio-base.el (eieio-instance-inheritor, slot-unbound)
+	(eieio-persistent-save-interactive, slot-missing):
+	Fix typos in docstrings.
+	(eieio-instance-inheritor-slot-boundp): Doc fix.
+
+	* emacs-lisp/eieio-comp.el (byte-compile-file-form-defmethod)
+	(byte-compile-defmethod-param-convert): Fix typos in docstrings.
+
+	* emacs-lisp/eieio-custom.el (eieio-done-customizing)
+	(eieio-custom-object-apply-reset):
+	Fix typos in docstrings and error messages.
+
+	* emacs-lisp/eieio-datadebug.el (data-debug-show):
+	Fix typo in docstring.
+
+	* emacs-lisp/eieio-opt.el (top): Fix typo in error message.
+	(eieio-browse-tree): Doc fix.
+	(eieio-all-generic-functions, eieio-class-speedbar): Reflow docstrings.
+	(eieio-help-mode-augmentation-maybee, eieio-class-speedbar-make-map):
+	Fix typos in docstrings.
+
+	* emacs-lisp/eieio-speedbar.el (eieio-speedbar-file-button): Doc fix.
+	(eieio-speedbar-key-map, eieio-speedbar-create-engine)
+	(eieio-speedbar-buttons, eieio-speedbar, eieio-speedbar-object-children)
+	(eieio-speedbar-make-tag-line, eieio-speedbar-object-expand):
+	Reflow docstrings.
+
 2009-10-05  Dan Nicolaescu  <dann@ics.uci.edu>
 
 	* vc-hg.el (log-view-vc-backend): Declare for compiler.
@@ -24,14 +77,13 @@
 	(tramp-methods): Add recursive option to `tramp-copy-args'.  Add
 	`tramp-copy-recursive'.  Valid for "rcp", "scp", "scp1", "scp2",
 	"scp1_old", "scp2_old", "rsync", "rsyncc".
-	(tramp-default-method): Check also for
-	`auth-source-user-or-password'.
+	(tramp-default-method): Check also for `auth-source-user-or-password'.
 	(tramp-file-name-handler-alist, tramp-file-name-for-operation):
 	Add handler for `copy-directory'.
 	(tramp-handle-copy-directory): New defun.
 	(tramp-do-copy-or-rename-file-out-of-band): Handle directory case.
-	(tramp-handle-start-file-process): Raise an error when PROGRAM is
-	nil.  Optimize sent command.
+	(tramp-handle-start-file-process): Raise an error when PROGRAM is nil.
+	Optimize sent command.
 
 2009-10-05  Stefan Monnier  <monnier@iro.umontreal.ca>
 
@@ -4741,7 +4793,7 @@
 	blocks.
 	(verilog-init-font) Remove definition & use of verilog-init-font,
 	as it is redundant with font-lock-defaults.
-	(verilog-mode): Alter the definition of verilog-font-lock-defualts
+	(verilog-mode): Alter the definition of verilog-font-lock-defaults
 	to avoid circular calls if syntax-ppss is a function (as is the
 	case now in 22.x GNU Emacs) as that function would sometimes call
 	itself, leading to (nearly) infinite recursion.

lisp/emacs-lisp/chart.el

@@ -87,7 +87,7 @@ Colors will be the background color.")
 	   (display-graphic-p))
       '("dimple1" "scales" "dot" "cross_weave" "boxes" "dimple3"))
   "If pixmaps are allowed, display these background pixmaps.
-Useful if new Emacs is used on B&W display")
+Useful if new Emacs is used on B&W display.")
 
 (defcustom chart-face-use-pixmaps nil
   "*Non-nil to use fancy pixmaps in the background of chart face colors."
@@ -133,7 +133,7 @@ Useful if new Emacs is used on B&W display")
 
 (defun chart-new-buffer (obj)
   "Create a new buffer NAME in which the chart OBJ is displayed.
-Returns the newly created buffer"
+Returns the newly created buffer."
   (save-excursion
     (set-buffer (get-buffer-create (format "*%s*" (oref obj title))))
     (chart-mode)
@@ -162,7 +162,7 @@ Returns the newly created buffer"
    (sequences :initarg :sequences
 	      :initform nil)
    )
-  "Superclass for all charts to be displayed in an emacs buffer")
+  "Superclass for all charts to be displayed in an Emacs buffer.")
 
 (defmethod initialize-instance :AFTER ((obj chart) &rest fields)
   "Initialize the chart OBJ being created with FIELDS.
@@ -188,13 +188,13 @@ Make sure the width/height is correct."
   ((bounds :initarg :bounds
 	   :initform '(0.0 . 50.0))
    )
-  "Class used to display an axis defined by a range of values")
+  "Class used to display an axis defined by a range of values.")
 
 (defclass chart-axis-names (chart-axis)
   ((items :initarg :items
 	  :initform nil)
    )
-  "Class used to display an axis which represents different named items")
+  "Class used to display an axis which represents different named items.")
 
 (defclass chart-sequece ()
   ((data :initarg :data
@@ -202,16 +202,16 @@ Make sure the width/height is correct."
    (name :initarg :name
 	 :initform "Data")
    )
-  "Class used for all data in different charts")
+  "Class used for all data in different charts.")
 
 (defclass chart-bar (chart)
   ((direction :initarg :direction
 	      :initform vertical))
-  "Subclass for bar charts. (Vertical or horizontal)")
+  "Subclass for bar charts (vertical or horizontal).")
 
 (defmethod chart-draw ((c chart) &optional buff)
   "Start drawing a chart object C in optional BUFF.
-Erases current contents of buffer"
+Erases current contents of buffer."
   (save-excursion
     (if buff (set-buffer buff))
     (erase-buffer)
@@ -256,7 +256,7 @@ Argument C is the chart object."
   )
 
 (defmethod chart-axis-draw ((a chart-axis) &optional dir margin zone start end)
-  "Draw some axis for A in direction DIR at with MARGIN in boundry.
+  "Draw some axis for A in direction DIR with MARGIN in boundary.
 ZONE is a zone specification.
 START and END represent the boundary."
   (chart-draw-line dir (+ margin (if zone zone 0)) start end)
@@ -339,8 +339,8 @@ Automatically compensates for for direction."
 
 (defmethod chart-axis-draw ((a chart-axis-names) &optional dir margin zone start end)
   "Draw axis information based upon A range to be spread along the edge.
-Optional argument DIR the direction of the chart.
-Optional argument MARGIN , ZONE, START and END specify boundaries of the drawing."
+Optional argument DIR is the direction of the chart.
+Optional arguments MARGIN, ZONE, START and END specify boundaries of the drawing."
   (call-next-method)
   ;; We prefer about 5 spaces between each value
   (let* ((i 0)
@@ -465,7 +465,7 @@ or is created with the bounds of SEQ."
 
 (defmethod chart-sort ((c chart) pred)
   "Sort the data in chart C using predicate PRED.
-See `chart-sort-matchlist' for more details"
+See `chart-sort-matchlist' for more details."
   (let* ((sl (oref c sequences))
 	 (s1 (car sl))
 	 (s2 (car (cdr sl)))
@@ -486,9 +486,9 @@ See `chart-sort-matchlist' for more details"
   )
 
 (defun chart-sort-matchlist (namelst numlst pred)
-  "Sort NAMELST and NUMLST (both SEQUENCE objects) based on predicate PRED.
+  "Sort NAMELST and NUMLST (both sequence objects) based on predicate PRED.
 PRED should be the equivalent of '<, except it must expect two
-cons cells of the form (NAME . NUM).  See SORT for more details."
+cons cells of the form (NAME . NUM).  See `sort' for more details."
   ;; 1 - create 1 list of cons cells
   (let ((newlist nil)
 	(alst (oref namelst data))
@@ -557,7 +557,7 @@ Optional argument FACE is the property we wish to place on this text."
 
 (defun chart-draw-line (dir zone start end)
   "Draw a line using line-drawing characters in direction DIR.
-Use column or row ZONE between START and END"
+Use column or row ZONE between START and END."
   (chart-display-label
    (make-string (- end start) (if (eq dir 'vertical) ?| ?\-))
    dir zone start end))
@@ -578,12 +578,12 @@ R1 and R2 are dotted pairs.  Colorize it with FACE."
 
 (defun chart-bar-quickie (dir title namelst nametitle numlst numtitle
 			      &optional max sort-pred)
-  "Wash over the complex eieio stuff and create a nice bar chart.
+  "Wash over the complex EIEIO stuff and create a nice bar chart.
 Create it going in direction DIR ['horizontal 'vertical] with TITLE
 using a name sequence NAMELST labeled NAMETITLE with values NUMLST
 labeled NUMTITLE.
 Optional arguments:
-Set the charts' max element display to MAX, and sort lists with
+Set the chart's max element display to MAX, and sort lists with
 SORT-PRED if desired."
   (let ((nc (make-instance chart-bar
 			   :title title

lisp/emacs-lisp/eieio-base.el

@@ -42,7 +42,7 @@
 		    :type eieio-instance-inheritor-child
 		    :documentation
 		    "The parent of this instance.
-If a slot of this class is reference, and is unbound, then  the parent
+If a slot of this class is referenced, and is unbound, then the parent
 is checked for a value.")
    )
   "This special class can enable instance inheritance.
@@ -53,7 +53,7 @@ not been set, use values from the parent."
 
 (defmethod slot-unbound ((object eieio-instance-inheritor) class slot-name fn)
   "If a slot OBJECT in this CLASS is unbound, try to inherit, or throw a signal.
-SLOT-NAME, is the offending slot.  FN is the function signalling the error."
+SLOT-NAME is the offending slot.  FN is the function signalling the error."
   (if (slot-boundp object 'parent-instance)
       ;; It may not look like it, but this line recurses back into this
       ;; method if the parent instance's slot is unbound.
@@ -85,9 +85,9 @@ All slots are unbound, except those initialized with PARAMS."
 
 (defmethod eieio-instance-inheritor-slot-boundp ((object eieio-instance-inheritor)
 						slot)
-  "Non-nil if the instance inheritor OBJECT's SLOT is bound.
-See `slot-boundp' for for details on binding slots.
-The instance inheritor uses unbound slots as a way cascading cloned
+  "Return non-nil if the instance inheritor OBJECT's SLOT is bound.
+See `slot-boundp' for details on binding slots.
+The instance inheritor uses unbound slots as a way of cascading cloned
 slot values, so testing for a slot being bound requires extra steps
 for this kind of object."
   (if (slot-boundp object slot)
@@ -213,7 +213,7 @@ specified will not be saved."
 
 (defmethod eieio-persistent-save-interactive ((this eieio-persistent) prompt
 					      &optional name)
-  "Perpare to save THIS.  Use in an `interactive' statement.
+  "Prepare to save THIS.  Use in an `interactive' statement.
 Query user for file name with PROMPT if THIS does not yet specify
 a file.  Optional argument NAME specifies a default file name."
   (unless (slot-boundp this 'file)
@@ -308,7 +308,7 @@ access to it."
 			 slot-name operation &optional new-value)
   "Called when a on-existant slot is accessed.
 For variable `eieio-named', provide an imaginary `object-name' slot.
-Argument OBJ is the Named object.
+Argument OBJ is the named object.
 Argument SLOT-NAME is the slot that was attempted to be accessed.
 OPERATION is the type of access, such as `oref' or `oset'.
 NEW-VALUE is the value that was being set into SLOT if OPERATION were

lisp/emacs-lisp/eieio-comp.el

@@ -52,9 +52,9 @@
 
 (defun byte-compile-file-form-defmethod (form)
   "Mumble about the method we are compiling.
-This function is mostly ripped from `byte-compile-file-form-defun', but
-it's been modified to handle the special syntax of the defmethod
-command.  There should probably be one for defgeneric as well, but
+This function is mostly ripped from `byte-compile-file-form-defun',
+but it's been modified to handle the special syntax of the `defmethod'
+command.  There should probably be one for `defgeneric' as well, but
 that is called but rarely.  Argument FORM is the body of the method."
   (setq form (cdr form))
   (let* ((meth (car form))
@@ -125,7 +125,7 @@ that is called but rarely.  Argument FORM is the body of the method."
     nil))
 
 (defun byte-compile-defmethod-param-convert (paramlist)
-  "Convert method params into the params used by the defmethod thingy.
+  "Convert method params into the params used by the `defmethod' thingy.
 Argument PARAMLIST is the parameter list to convert."
   (let ((argfix nil))
     (while paramlist

lisp/emacs-lisp/eieio-custom.el

@@ -90,7 +90,7 @@ of these.")
 (defvar eieio-cog nil
   "Buffer local variable in object customize buffers for the current group.")
 
- (defvar eieio-custom-ignore-eieio-co  nil
+ (defvar eieio-custom-ignore-eieio-co nil
    "When true, all customizable slots of the current object are updated.
 Updates occur regardless of the current customization group.")
 
@@ -227,7 +227,7 @@ Optional argument IGNORE is an extraneous parameter."
       (when (and (car fcust)
 		 (or (not master-group) (member master-group (car fgroup)))
 		 (slot-boundp obj (car slots)))
-	;; In this case, this slot has a custom type.  Create it's
+	;; In this case, this slot has a custom type.  Create its
 	;; children widgets.
 	(let ((type (eieio-filter-slot-type widget (car fcust)))
 	      (stuff nil))
@@ -320,9 +320,9 @@ Optional argument IGNORE is an extraneous parameter."
     obj))
 
 (defmethod eieio-done-customizing ((obj eieio-default-superclass))
-  "When a applying change to a widget, call this method.
-This method is called by the default widget-edit commands.  User made
-commands should also call this method when applying changes.
+  "When applying change to a widget, call this method.
+This method is called by the default widget-edit commands.
+User made commands should also call this method when applying changes.
 Argument OBJ is the object that has been customized."
   nil)
 
@@ -374,7 +374,7 @@ These groups are specified with the `:group' slot flag."
 
 (defmethod eieio-custom-object-apply-reset ((obj eieio-default-superclass))
   "Insert an Apply and Reset button into the object editor.
-Argument OBJ os the object being customized."
+Argument OBJ is the object being customized."
   (widget-create 'push-button
 		 :notify (lambda (&rest ignore)
 			   (widget-apply eieio-wo :value-get)
@@ -385,16 +385,16 @@ Argument OBJ os the object being customized."
   (widget-create 'push-button
 		 :notify (lambda (&rest ignore)
 			   ;; I think the act of getting it sets
-			   ;; it's value through the get function.
+			   ;; its value through the get function.
 			   (message "Applying Changes...")
 			   (widget-apply eieio-wo :value-get)
 			   (eieio-done-customizing eieio-co)
-			   (message "Applying Changes...Done."))
+			   (message "Applying Changes...Done"))
 		 "Apply")
   (widget-insert "   ")
   (widget-create 'push-button
 		 :notify (lambda (&rest ignore)
-			   (message "Resetting.")
+			   (message "Resetting")
 			   (eieio-customize-object eieio-co eieio-cog))
 		 "Reset")
   (widget-insert "   ")

lisp/emacs-lisp/eieio-datadebug.el

@@ -122,7 +122,7 @@ PREBUTTONTEXT is some text between PREFIX and the object button."
 ;; A generic function to run DDEBUG on an object and popup a new buffer.
 ;;
 (defmethod data-debug-show ((obj eieio-default-superclass))
-  "Run ddebug against any EIEIO object OBJ"
+  "Run ddebug against any EIEIO object OBJ."
   (data-debug-new-buffer (format "*%s DDEBUG*" (object-name obj)))
   (data-debug-insert-object-slots obj "]"))
 

lisp/emacs-lisp/eieio-opt.el

@@ -51,7 +51,7 @@ variable `eieio-default-superclass'."
     ))
 
 (defun eieio-browse-tree (this-root prefix ch-prefix)
-  "Recursively, draws the children of the given class on the screen.
+  "Recursively draw the children of the given class on the screen.
 Argument THIS-ROOT is the local root of the tree.
 Argument PREFIX is the character prefix to use.
 Argument CH-PREFIX is another character prefix to display."
@@ -389,7 +389,8 @@ Also extracts information about all methods specific to this generic."
 
 (defun eieio-all-generic-functions (&optional class)
   "Return a list of all generic functions.
-Optional CLASS argument returns only those functions that contain methods for CLASS."
+Optional CLASS argument returns only those functions that contain
+methods for CLASS."
   (let ((l nil) tree (cn (if class (symbol-name class) nil)))
     (mapatoms
      (lambda (symbol)
@@ -552,7 +553,7 @@ Optional argument HISTORYVAR is the variable to use as history."
 ;;; HELP AUGMENTATION
 ;;
 (defun eieio-help-mode-augmentation-maybee (&rest unused)
-  "For buffers thrown into help mode, augment for eieio.
+  "For buffers thrown into help mode, augment for EIEIO.
 Arguments UNUSED are not used."
   ;; Scan created buttons so far if we are in help mode.
   (when (eq major-mode 'help-mode)
@@ -600,13 +601,13 @@ Arguments UNUSED are not used."
 (eval-when-compile
   (condition-case nil
       (require 'speedbar)
-    (error (message "Error loading speedbar... ignored."))))
+    (error (message "Error loading speedbar... ignored"))))
 
 (defvar eieio-class-speedbar-key-map nil
   "Keymap used when working with a project in speedbar.")
 
 (defun eieio-class-speedbar-make-map ()
-  "Make a keymap for eieio under speedbar."
+  "Make a keymap for EIEIO under speedbar."
   (setq eieio-class-speedbar-key-map (speedbar-make-specialized-keymap))
 
   ;; General viewing stuff
@@ -637,8 +638,8 @@ Arguments UNUSED are not used."
 
 (defun eieio-class-speedbar (dir-or-object depth)
   "Create buttons in speedbar that represents the current project.
-DIR-OR-OBJECT is the object to expand, or nil, and DEPTH is the current
-expansion depth."
+DIR-OR-OBJECT is the object to expand, or nil, and DEPTH is the
+current expansion depth."
   (when (eq (point-min) (point-max))
     ;; This function is only called once, to start the whole deal.
     ;; Ceate, and expand the default object.

lisp/emacs-lisp/eieio-speedbar.el

@@ -113,7 +113,7 @@
     map))
 
 (defvar eieio-speedbar-key-map (eieio-speedbar-make-map)
-  "A Generic object based speedbar display keymap.")
+  "A generic object based speedbar display keymap.")
 
 (defvar eieio-speedbar-menu
   '([ "Edit Object/Field" speedbar-edit-line t]
@@ -150,7 +150,7 @@ creating the speedbar display."
 (defun eieio-speedbar-create-engine (map-fn map-var menu-var modename fetcher)
   "Create a speedbar mode for displaying an object hierarchy.
 Called from `eieio-speedbar-create', or the speedbar load-hook.
-MAP-FN, MAP-VAR, MENU-VAR, MODENAME, and FETCHER are the same as
+MAP-FN, MAP-VAR, MENU-VAR, MODENAME, and FETCHER are the same as in
 `eieio-speedbar-create'."
   ;; make sure the keymap exists
   (funcall map-fn)
@@ -171,7 +171,7 @@ MAP-FN, MAP-VAR, MENU-VAR, MODENAME, and FETCHER are the same as
 (defun eieio-speedbar-buttons (dir-or-object depth fetcher)
   "Create buttons for the speedbar display.
 Start in directory DIR-OR-OBJECT.  If it is an object, just display that
-objects subelements.
+object's subelements.
 Argument DEPTH specifies how far down we have already been displayed.
 If it is a directory, use FETCHER to fetch all objects associated with
 that path."
@@ -263,7 +263,7 @@ See `speedbar-make-tag-line' for details."
 	     "State of an object being expanded in speedbar.")
    )
   "Class which provides basic speedbar support for child classes.
-Add one of thie child classes to this class to the parent list of a class."
+Add one of the child classes to this class to the parent list of a class."
   :method-invocation-order :depth-first
   :abstract t)
 
@@ -277,7 +277,7 @@ Add one of thie child classes to this class to the parent list of a class."
 (defclass eieio-speedbar-file-button (eieio-speedbar)
   ((buttontype :initform bracket)
    (buttonface :initform speedbar-file-face))
-  "Class providing support for objects which behave like a directory."
+  "Class providing support for objects which behave like a file."
   :method-invocation-order :depth-first
   :abstract t)
 
@@ -287,8 +287,8 @@ Add one of thie child classes to this class to the parent list of a class."
 (defmethod eieio-speedbar-make-tag-line ((object eieio-speedbar)
 					 depth)
   "Insert a tag line into speedbar at point for OBJECT.
-All objects a child of symbol `eieio-speedbar' can be created from this
-method.  Override this if you need non-traditional tag lines.
+All objects a child of symbol `eieio-speedbar' can be created from
+this method.  Override this if you need non-traditional tag lines.
 Argument DEPTH is the depth at which the tag line is inserted."
   (let ((children (eieio-speedbar-object-children object))
 	(exp (oref object expanded)))
@@ -345,8 +345,8 @@ The object is at indentation level INDENT."
   (eieio-speedbar-handle-click token))
 
 (defun eieio-speedbar-object-expand (text token indent)
-  "Expand object represented by TEXT.  TOKEN is the object.
-INDENT is the current indentation level."
+  "Expand object represented by TEXT.
+TOKEN is the object.  INDENT is the current indentation level."
   (cond ((string-match "+" text)	;we have to expand this file
 	 (speedbar-change-expand-button-char ?-)
 	 (oset token expanded t)
@@ -412,7 +412,7 @@ Optional DEPTH is the depth we start at."
 ;;; Methods to the eieio-speedbar-* classes which need to be overriden.
 ;;
 (defmethod eieio-speedbar-object-children ((object eieio-speedbar))
-  "Return a list of children to be displayed in SPEEDBAR.
+  "Return a list of children to be displayed in speedbar.
 If the return value is a list of OBJECTs, then those objects are
 queried for details.  If the return list is made of strings,
 then this object will be queried for the details needed