Minor improvements to documentation.
authorChris Mann <cshclm@gmail.com>
Tue, 29 Sep 2009 13:26:26 +0000 (29 22:56 +0930)
committerChris Mann <cshclm@gmail.com>
Tue, 29 Sep 2009 13:26:26 +0000 (29 22:56 +0930)
* wesnoth-mode.el (wesnoth-allow-accurate-validation, wesnoth-element-opening,
  wesnoth-element): Updated docstring.

wesnoth-mode.el

index 9e63f28..307b9ca 100644 (file)
@@ -34,6 +34,7 @@
 
 ;;; History:
 ;; 1.3.5+git
+;; * Add support for ido completion (see `wesnoth-use-alternate-completion')
 ;; * Add support for WML validation on a directory.
 ;; * Add support for more accurate WML validation. (See
 ;;   `wesnoth-allow-accurate-validation'.)
@@ -243,8 +244,8 @@ level as their parent.")
 If non-nil, allow a more accurate method (which is able to better
 determine the current element's parent) to be used.  Note that
 this may cause WML validation to slow significantly when checking
-error-prone or messy WML.  If clean WML is generally used, it is
-recommended to set this to non-nil."
+error-prone or messy WML.  If WML checked is rarely incorrect it
+is recommended to set this to non-nil."
   :type 'boolean
   :group 'wesnoth-mode)
 
@@ -375,7 +376,7 @@ If LIMITED is non-nil, return a regexp which matches only the
          "\\)"))
 
 (defun wesnoth-element-opening (&optional limited)
-  "Return the regexp to match a closing element.
+  "Return the regexp to match an opening element.
 If LIMITED is non-nil, return a regexp which matches only the
 #define preprocessor."
   (concat "^[\t ]*\\(\\[\\+?\\(\\w\\|_\\)+\\]\\|#define "
@@ -388,7 +389,7 @@ If LIMITED is non-nil, return a regexp which matches only the
          "\\)"))
 
 (defun wesnoth-element (&optional limited)
-  "Return the regexp to match a closing element.
+  "Return the regexp to match any element.
 If LIMITED is non-nil, return a regexp which matches only the
 #define and #enddef preprocessors."
   (concat "^[\t ]*\\(\\[[+/]?\\(\\w\\|_\\)+\\]?\\|"
@@ -457,7 +458,7 @@ element types to find."
 Return non-nil when an element is found.  Otherwise, return nil."
   (interactive)
   (if (= (point) (wesnoth-wml-start-pos))
-    nil
+      nil
     (let ((init-element (save-excursion (wesnoth-next-element)))
           last-element cur-element)
       (save-match-data
@@ -467,8 +468,8 @@ Return non-nil when an element is found.  Otherwise, return nil."
         (when (car cur-element)
           (setq last-element cur-element)))
       (goto-char (or (cadr last-element) (cadr init-element) (point-min))))
-  ;; Determine whether currently within a string, and move to its beginning
-  ;; where necessary.
+    ;; Determine whether currently within a string, and move to its beginning
+    ;; where necessary.
     (save-excursion
       (let ((details (wesnoth-element-type (point))))
         (save-match-data