mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

Add notes about documenting default values

Browse source 
* CONTRIBUTE: Ask people to document default values when adding new user
  options.
This commit is contained in:
Robert Pluim 2024-09-11 18:09:29 +02:00
parent 7376623a24
commit b486390862
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTE
View file

@ -110,8 +110,11 @@ admin/notes/bug-triage.
Any change that matters to end-users should have an entry in etc/NEWS. Any change that matters to end-users should have an entry in etc/NEWS.
Try to start each NEWS entry with a sentence that summarizes the entry Try to start each NEWS entry with a sentence that summarizes the entry
and takes just one line -- this will allow reading NEWS in Outline and takes just one line -- this will allow reading NEWS in Outline mode
mode after hiding the body of each entry. after hiding the body of each entry. When adding a new user option that
allows changing behavior, please document its default value. Similarly,
changes to the default value of an existing user option should be
announced.
Doc-strings should be updated together with the code. Doc-strings should be updated together with the code.