aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMark Oteiza2017-09-01 17:31:45 -0400
committerMark Oteiza2017-09-01 17:31:45 -0400
commit55ac7505a094c7c3d9ee28c7668a0179a072b889 (patch)
tree5f039bfdf380ecd3f0f6977ff3f1790d5f25defe
parent4bc2795a401cf31fa8bb4d5a45698b181951786f (diff)
downloademacs-55ac7505a094c7c3d9ee28c7668a0179a072b889.tar.gz
emacs-55ac7505a094c7c3d9ee28c7668a0179a072b889.zip
Turn off checkdoc complaint about default argument order
* etc/NEWS: Mention change. * lisp/emacs-lisp/checkdoc.el (checkdoc-arguments-in-order-flag): Disable by default, note version.
-rw-r--r--etc/NEWS5
-rw-r--r--lisp/emacs-lisp/checkdoc.el3
2 files changed, 7 insertions, 1 deletions
diff --git a/etc/NEWS b/etc/NEWS
index d32b0e5bc89..be95504cfd4 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -673,6 +673,11 @@ bound to 'Buffer-menu-unmark-all-buffers'.
673*** Two new commands 'Buffer-menu-unmark-all', bound to 'U' and 673*** Two new commands 'Buffer-menu-unmark-all', bound to 'U' and
674'Buffer-menu-unmark-all-buffers', bound to 'M-DEL'. 674'Buffer-menu-unmark-all-buffers', bound to 'M-DEL'.
675 675
676---
677** Checkdoc
678
679*** 'checkdoc-arguments-in-order-flag' now defaults to nil.
680
676** Gnus 681** Gnus
677 682
678--- 683---
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 1d6fdfa4e87..bc67a6be51a 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -258,12 +258,13 @@ Any more than this and a warning is generated suggesting that the construct
258\\ {keymap} be used instead." 258\\ {keymap} be used instead."
259 :type 'integer) 259 :type 'integer)
260 260
261(defcustom checkdoc-arguments-in-order-flag t 261(defcustom checkdoc-arguments-in-order-flag nil
262 "Non-nil means warn if arguments appear out of order. 262 "Non-nil means warn if arguments appear out of order.
263Setting this to nil will mean only checking that all the arguments 263Setting this to nil will mean only checking that all the arguments
264appear in the proper form in the documentation, not that they are in 264appear in the proper form in the documentation, not that they are in
265the same order as they appear in the argument list. No mention is 265the same order as they appear in the argument list. No mention is
266made in the style guide relating to order." 266made in the style guide relating to order."
267 :version "26.1"
267 :type 'boolean) 268 :type 'boolean)
268;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable #'booleanp) 269;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable #'booleanp)
269 270