[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#26925: Improve /doc/lispref/strings.texi (split-string) documentatio
From: |
Jean-Christophe Helary |
Subject: |
bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation |
Date: |
Mon, 5 Jun 2017 14:15:55 +0900 |
>>> Does that mean that you suggest we explicitly declare them optional in
>>> split-string ?
>>
>> Yes, I think so.
>
> Ok, I'll do it.
I've checked subr.el and the only functions that specifically document an
argument as optional in the doc string are:
alist-get
suppress-keymap
substitute-key-definition
add-hook
remove-hook
add-to-list (only 1 out of 2)
add-to-ordered-list
add-to-history
add-minor-mode
locate-library (2/3)
process-kill-without-query
read-passwd
read-char-choice
sit-for
momentary-string-display
sha1 (2/3)
match-substitute-replacement
subst-char-in-string
replace-regexp-in-string
define-mail-user-agent
set-transient-map
make-progress-reporter (3/5)
out of 52 defuns (and 2 defsubst) that use &optional.
Should we modify all the remaining docstrings so that they explicitly specify
when an argument is optional?
Jean-Christophe
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, (continued)
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Jean-Christophe Helary, 2017/06/03
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Eli Zaretskii, 2017/06/03
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Michael Albinus, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Jean-Christophe Helary, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Eli Zaretskii, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Jean-Christophe Helary, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Eli Zaretskii, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Jean-Christophe Helary, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Eli Zaretskii, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Jean-Christophe Helary, 2017/06/04
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation,
Jean-Christophe Helary <=
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Eli Zaretskii, 2017/06/05
- bug#26925: Improve /doc/lispref/strings.texi (split-string) documentation, Jean-Christophe Helary, 2017/06/05