From: Stefan Kangas Date: Sun, 7 Jul 2024 20:32:20 +0000 (+0200) Subject: * etc/TODO: Add item to convert documentation to 'setopt'. X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=a4cd47b2539cad0f1833421d88bd89efdf9abb80;p=emacs.git * etc/TODO: Add item to convert documentation to 'setopt'. (cherry picked from commit 198063ba643ae42ba3464317af38abcaf1fac550) --- diff --git a/etc/TODO b/etc/TODO index 2750e3c114d..78e88c99397 100644 --- a/etc/TODO +++ b/etc/TODO @@ -88,6 +88,15 @@ outside of the mode they were written for. Verify the conversion by comparing the value of the keymap before converting it and after (you can see the value in 'C-h v'). +** Change documentation examples to use 'setopt' instead of 'setq' +User options are variables defined with 'defcustom', as opposed to +'defvar' or 'defconst'. It is preferable to use 'setopt' to set user +options instead of 'setq', since it will execute any ‘custom-set’ form +associated with that variable. Pick a package and make sure that it +uses 'setopt' in any examples in its documentation (doc strings, manual, +Commentary section, etc.). Note that 'setopt' is new in Emacs 29.1, so +packages that need support for earlier versions should still use 'setq'. + ** Write more tests Pick a fixed bug from the database, write a test case to make sure it stays fixed. Or pick your favorite programming major-mode, and write