aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Monnier2006-08-25 23:40:38 +0000
committerStefan Monnier2006-08-25 23:40:38 +0000
commit76667462a2ff4e447891dda32122e108e2a39ac2 (patch)
treea61747db2ca2c590fc9f1abcf95365724bdd43ea
parent8929fd8784f3029494d04fef6896247385c9d6c0 (diff)
downloademacs-76667462a2ff4e447891dda32122e108e2a39ac2.tar.gz
emacs-76667462a2ff4e447891dda32122e108e2a39ac2.zip
Remove * in defcustoms.
(defgroup checkdoc): Move to beginning.
-rw-r--r--lisp/ChangeLog3
-rw-r--r--lisp/emacs-lisp/checkdoc.el34
2 files changed, 21 insertions, 16 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index eacc773d434..42b27ff66bf 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
12006-08-25 Stefan Monnier <monnier@iro.umontreal.ca> 12006-08-25 Stefan Monnier <monnier@iro.umontreal.ca>
2 2
3 * emacs-lisp/checkdoc.el: Remove * in defcustoms.
4 (defgroup checkdoc): Move to beginning.
5
3 * progmodes/python.el (python-preoutput-skip-next-prompt): New var. 6 * progmodes/python.el (python-preoutput-skip-next-prompt): New var.
4 (python-preoutput-continuation): Remove. 7 (python-preoutput-continuation): Remove.
5 (python-preoutput-filter): Simplify correspondingly. 8 (python-preoutput-filter): Simplify correspondingly.
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index bbeea5d703d..68603c905a5 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -193,8 +193,14 @@
193(defvar compilation-error-regexp-alist) 193(defvar compilation-error-regexp-alist)
194(defvar compilation-mode-font-lock-keywords) 194(defvar compilation-mode-font-lock-keywords)
195 195
196(defgroup checkdoc nil
197 "Support for doc string checking in Emacs Lisp."
198 :prefix "checkdoc"
199 :group 'lisp
200 :version "20.3")
201
196(defcustom checkdoc-autofix-flag 'semiautomatic 202(defcustom checkdoc-autofix-flag 'semiautomatic
197 "*Non-nil means attempt auto-fixing of doc strings. 203 "Non-nil means attempt auto-fixing of doc strings.
198If this value is the symbol `query', then the user is queried before 204If this value is the symbol `query', then the user is queried before
199any change is made. If the value is `automatic', then all changes are 205any change is made. If the value is `automatic', then all changes are
200made without asking unless the change is very-complex. If the value 206made without asking unless the change is very-complex. If the value
@@ -208,37 +214,39 @@ The value `never' is the same as nil, never ask or change anything."
208 (other :tag "semiautomatic" semiautomatic))) 214 (other :tag "semiautomatic" semiautomatic)))
209 215
210(defcustom checkdoc-bouncy-flag t 216(defcustom checkdoc-bouncy-flag t
211 "*Non-nil means to \"bounce\" to auto-fix locations. 217 "Non-nil means to \"bounce\" to auto-fix locations.
212Setting this to nil will silently make fixes that require no user 218Setting this to nil will silently make fixes that require no user
213interaction. See `checkdoc-autofix-flag' for auto-fixing details." 219interaction. See `checkdoc-autofix-flag' for auto-fixing details."
214 :group 'checkdoc 220 :group 'checkdoc
215 :type 'boolean) 221 :type 'boolean)
216 222
217(defcustom checkdoc-force-docstrings-flag t 223(defcustom checkdoc-force-docstrings-flag t
218 "*Non-nil means that all checkable definitions should have documentation. 224 "Non-nil means that all checkable definitions should have documentation.
219Style guide dictates that interactive functions MUST have documentation, 225Style guide dictates that interactive functions MUST have documentation,
220and that it's good but not required practice to make non user visible items 226and that it's good but not required practice to make non user visible items
221have doc strings." 227have doc strings."
222 :group 'checkdoc 228 :group 'checkdoc
223 :type 'boolean) 229 :type 'boolean)
230(put 'checkdoc-force-docstrings-flag 'safe-local-variable 'booleanp)
224 231
225(defcustom checkdoc-force-history-flag t 232(defcustom checkdoc-force-history-flag t
226 "*Non-nil means that files should have a History section or ChangeLog file. 233 "Non-nil means that files should have a History section or ChangeLog file.
227This helps document the evolution of, and recent changes to, the package." 234This helps document the evolution of, and recent changes to, the package."
228 :group 'checkdoc 235 :group 'checkdoc
229 :type 'boolean) 236 :type 'boolean)
230 237
231(defcustom checkdoc-permit-comma-termination-flag nil 238(defcustom checkdoc-permit-comma-termination-flag nil
232 "*Non-nil means the first line of a docstring may end with a comma. 239 "Non-nil means the first line of a docstring may end with a comma.
233Ordinarily, a full sentence is required. This may be misleading when 240Ordinarily, a full sentence is required. This may be misleading when
234there is a substantial caveat to the one-line description -- the comma 241there is a substantial caveat to the one-line description -- the comma
235should be used when the first part could stand alone as a sentence, but 242should be used when the first part could stand alone as a sentence, but
236it indicates that a modifying clause follows." 243it indicates that a modifying clause follows."
237 :group 'checkdoc 244 :group 'checkdoc
238 :type 'boolean) 245 :type 'boolean)
246(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable 'booleanp)
239 247
240(defcustom checkdoc-spellcheck-documentation-flag nil 248(defcustom checkdoc-spellcheck-documentation-flag nil
241 "*Non-nil means run Ispell on text based on value. 249 "Non-nil means run Ispell on text based on value.
242This is automatically set to nil if Ispell does not exist on your 250This is automatically set to nil if Ispell does not exist on your
243system. Possible values are: 251system. Possible values are:
244 252
@@ -259,14 +267,14 @@ system. Possible values are:
259 "List of words that are correct when spell-checking Lisp documentation.") 267 "List of words that are correct when spell-checking Lisp documentation.")
260 268
261(defcustom checkdoc-max-keyref-before-warn 10 269(defcustom checkdoc-max-keyref-before-warn 10
262 "*The number of \\ [command-to-keystroke] tokens allowed in a doc string. 270 "The number of \\ [command-to-keystroke] tokens allowed in a doc string.
263Any more than this and a warning is generated suggesting that the construct 271Any more than this and a warning is generated suggesting that the construct
264\\ {keymap} be used instead." 272\\ {keymap} be used instead."
265 :group 'checkdoc 273 :group 'checkdoc
266 :type 'integer) 274 :type 'integer)
267 275
268(defcustom checkdoc-arguments-in-order-flag t 276(defcustom checkdoc-arguments-in-order-flag t
269 "*Non-nil means warn if arguments appear out of order. 277 "Non-nil means warn if arguments appear out of order.
270Setting this to nil will mean only checking that all the arguments 278Setting this to nil will mean only checking that all the arguments
271appear in the proper form in the documentation, not that they are in 279appear in the proper form in the documentation, not that they are in
272the same order as they appear in the argument list. No mention is 280the same order as they appear in the argument list. No mention is
@@ -298,7 +306,7 @@ problem discovered. This is useful for adding additional checks.")
298A search leaves the cursor in front of the parameter list.") 306A search leaves the cursor in front of the parameter list.")
299 307
300(defcustom checkdoc-verb-check-experimental-flag t 308(defcustom checkdoc-verb-check-experimental-flag t
301 "*Non-nil means to attempt to check the voice of the doc string. 309 "Non-nil means to attempt to check the voice of the doc string.
302This check keys off some words which are commonly misused. See the 310This check keys off some words which are commonly misused. See the
303variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own." 311variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
304 :group 'checkdoc 312 :group 'checkdoc
@@ -2633,12 +2641,6 @@ function called to create the messages."
2633 (setq checkdoc-pending-errors nil) 2641 (setq checkdoc-pending-errors nil)
2634 nil))) 2642 nil)))
2635 2643
2636(defgroup checkdoc nil
2637 "Support for doc string checking in Emacs Lisp."
2638 :prefix "checkdoc"
2639 :group 'lisp
2640 :version "20.3")
2641
2642(custom-add-option 'emacs-lisp-mode-hook 2644(custom-add-option 'emacs-lisp-mode-hook
2643 (lambda () (checkdoc-minor-mode 1))) 2645 (lambda () (checkdoc-minor-mode 1)))
2644 2646
@@ -2650,5 +2652,5 @@ function called to create the messages."
2650 2652
2651(provide 'checkdoc) 2653(provide 'checkdoc)
2652 2654
2653;;; arch-tag: c49a7ec8-3bb7-46f2-bfbc-d5f26e033b26 2655;; arch-tag: c49a7ec8-3bb7-46f2-bfbc-d5f26e033b26
2654;;; checkdoc.el ends here 2656;;; checkdoc.el ends here