From 55ac7505a094c7c3d9ee28c7668a0179a072b889 Mon Sep 17 00:00:00 2001 From: Mark Oteiza Date: Fri, 1 Sep 2017 17:31:45 -0400 Subject: [PATCH] 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. --- etc/NEWS | 5 +++++ lisp/emacs-lisp/checkdoc.el | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) 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'. *** Two new commands 'Buffer-menu-unmark-all', bound to 'U' and 'Buffer-menu-unmark-all-buffers', bound to 'M-DEL'. +--- +** Checkdoc + +*** 'checkdoc-arguments-in-order-flag' now defaults to nil. + ** Gnus --- 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 \\ {keymap} be used instead." :type 'integer) -(defcustom checkdoc-arguments-in-order-flag t +(defcustom checkdoc-arguments-in-order-flag nil "Non-nil means warn if arguments appear out of order. Setting this to nil will mean only checking that all the arguments appear in the proper form in the documentation, not that they are in the same order as they appear in the argument list. No mention is made in the style guide relating to order." + :version "26.1" :type 'boolean) ;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable #'booleanp) -- 2.39.2