1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-14 10:00:25 -08:00
Commit graph

158 commits

Author SHA1 Message Date
Pip Cet
433b6fc53d Handle single-argument `apply' consistently (bug#40968)
* src/eval.c (Fapply): Handle (apply nil) without crashing.
Document single-argument form.
* lisp/emacs-lisp/byte-opt.el (byte-optimize-apply): Don't attempt
to optimize single-argument apply.
* doc/lispref/functions.texi (Calling Functions): Document
single-argument apply.  Provide example (bug#40968).
2020-09-27 16:59:00 +02:00
Lars Ingebrigtsen
4102fe1e91 Clarify inline-letevals in the manual
* doc/lispref/functions.texi (Inline Functions): Try to clarify
what inline-letevals really does, and how it differs from `let'
(bug#31052).
2020-08-22 17:57:39 +02:00
Eli Zaretskii
69568674b3 Improve documentation of function argument lists
* doc/lispref/functions.texi (Lambda Components)
(Defining Functions): Add a cross-reference to "Argument List".
(Argument List): Improve the section name.  (Bug#42750)
2020-08-13 17:08:37 +03:00
Mattias Engdegård
14a570afae Remove #' and function quoting from lambda forms in manual
* doc/lispref/abbrevs.texi (Abbrev Expansion):
* doc/lispref/backups.texi (Reverting):
* doc/lispref/functions.texi (Mapping Functions):
* doc/lispref/help.texi (Accessing Documentation):
* doc/lispref/sequences.texi (Char-Tables):
* doc/lispref/syntax.texi (Categories):
* doc/lispref/text.texi (Sorting):
Remove function quoting from lambda in examples where it still occurs,
since examples should follow our best style and be consistent.
2020-04-19 13:19:37 +02:00
Štěpán Němec
067b070598 ; Fix some typos and doc issues (bug#40695) 2020-04-18 17:10:02 +02:00
Richard Stallman
fd8128f0c1 ; Move the description of define-inline to a different node in functions.texi 2020-01-11 11:48:17 +02:00
Paul Eggert
365e01cc9f Update copyright year to 2020
Run "TZ=UTC0 admin/update-copyright $(git ls-files)".
2020-01-01 00:59:52 +00:00
Eli Zaretskii
32222fb34c Fix documentation of define-obsolete-* functions
* doc/lispref/functions.texi (Obsolete Functions): Make
documentation of functions that obsolete symbols match the
advertised calling conventions.

* lisp/emacs-lisp/byte-run.el (define-obsolete-function-alias)
(define-obsolete-variable-alias, define-obsolete-face-alias):
State in the doc strings that WHEN is a mandatory argument, to be
consistent with the advertised calling convention.  (Bug#38675)
2019-12-28 11:13:25 +02:00
Eli Zaretskii
48169f7c65 Improve indexing of function doc string conventions
* doc/lispref/functions.texi (Function Documentation): Improve
indexing (bug#38158).
2019-11-15 11:42:11 +02:00
Richard Stallman
8758c96dc7 Minor wording change in ELisp manual
* doc/lispref/functions.texi (Advising Named Functions):
Improve and clarify wording of the advice to avoid advising
functions in released code.
2019-11-01 11:45:51 +02:00
Juanma Barranquero
b3314ac5c4 identity, ignore: Make arg names more consistent with docs
* lisp/subr.el (ignore): Rename argument IGNORE to ARGUMENTS.

* src/fns.c (Fidentity): Rename ARG to ARGUMENT.

* doc/lispref/functions.texi (Calling Functions): Fix references.
2019-10-10 06:00:20 +02:00
Štěpán Němec
b8c4a9e0f8 Add an advice-add/interactive spec example
* doc/lispref/functions.texi (Core Advising Primitives): Add an
advice-add example that extends the `interactive' spec (bug#17871).
2019-08-18 16:05:48 -07:00
Lars Ingebrigtsen
21ada03d30 Capitalise a couple of node names
* doc/lispref/functions.texi (Advising Functions): Capitalise node
names (bug#17717).
(Advice Combinators, Porting Old Advice): Capitalise.
2019-08-04 14:50:07 +02:00
Lars Ingebrigtsen
151a99cca9 Core Advising Primitives `interactive' clarification
* doc/lispref/functions.texi (Core Advising Primitives): Clarify
when the interactive spec is a function (bug#17871).
2019-08-04 14:07:06 +02:00
Lars Ingebrigtsen
1a1b5f9802 Add a really simple nadvice example
* doc/lispref/functions.texi (Advising Functions): Add a really
trivial and simple example (bug#35250).
2019-07-09 17:13:54 +02:00
Glenn Morris
17a1dae4af Merge from origin/emacs-26
2168165 ; * doc/lispref/nonascii.texi (Explicit Encoding): Fix typo.
8f18d12 Improve documentation of decoding into a unibyte buffer
7681a57 Remove redundants "See" before @xref or @pxref (Bug#35793)
9bee762 ; * src/coding.c: Improve commentary.  (Bug#34765)
e61349c Fix customization type of recentf-max-saved-items

# Conflicts:
#	src/coding.c
2019-06-01 12:04:41 -07:00
Mauro Aranda
7681a57b88 Remove redundants "See" before @xref or @pxref (Bug#35793)
* doc/lispref/control.texi (Control Structures):
* doc/lispref/modes.texi (Search-based Fontification):
* doc/misc/cc-mode.texi (Filling and Line Breaking Commands)
(Auto-newline Insertion, Other Special Indentations):
* doc/misc/dbus.texi (Errors and Events):
* doc/misc/dired-x.texi (Find File At Point):
* doc/misc/eudc.texi (Display of Query Results, Inline Query Expansion):
* doc/misc/gnus-faq.texi (FAQ 3-11):
* doc/misc/gnus.texi (Group Parameters, Posting Styles)
(Spam Package Introduction):
* doc/misc/org.texi (LaTeX fragments, Previewing LaTeX fragments):
* doc/misc/reftex.texi (Commands):
Remove redundant "See" before cross references.
* doc/lispref/functions.texi (Function Safety): Redundant "see" is in
ignored text, but remove it anyway.
* doc/lispref/positions.texi (Skipping Characters): Remove redundant
"See" before cross references.  Change @xref to @pxref, which is
more suitable when at the end of a sentence.

Most of the redundants "See" found by Noam Postavsky.
2019-05-25 13:02:05 -04:00
Michael Heerdegen
84a3da15e9 Improve documentation of the 'function' special form
Point out that 'function' quoting is beneficial also for symbols.

* src/eval.c (function): Enhance docstring.
* doc/lispref/functions.texi (Anonymous Functions): Improve
documentation.
2019-05-24 00:51:46 +02:00
Basil L. Contovounesios
3988e93d4b Backport: Improve pure and side-effect-free docs
For discussion, see thread starting at:
https://lists.gnu.org/archive/html/emacs-devel/2019-04/msg00316.html
* doc/lispref/customize.texi (Composite Types): Do not overspecify
:match-alternatives predicates.
* doc/lispref/eval.texi (Intro Eval): Anchor definition of "side
effect" for cross-referencing...
* doc/lispref/functions.texi (What Is a Function): ...from here.
Define what a pure function is.
* doc/lispref/internals.texi (Writing Emacs Primitives): Describe
currently preferred approach to marking primitives as pure and
side-effect-free.
* doc/lispref/symbols.texi (Standard Properties): Expand description
of pure and side-effect-free properties.

(cherry picked from commit 4430a9b54f)
2019-04-22 16:14:33 +01:00
Basil L. Contovounesios
4430a9b54f Improve pure and side-effect-free docs
For discussion, see thread starting at:
https://lists.gnu.org/archive/html/emacs-devel/2019-04/msg00316.html
* doc/lispref/customize.texi (Composite Types): Do not overspecify
:match-alternatives predicates.
* doc/lispref/eval.texi (Intro Eval): Anchor definition of "side
effect" for cross-referencing...
* doc/lispref/functions.texi (What Is a Function): ...from here.
Define what a pure function is.
* doc/lispref/internals.texi (Writing Emacs Primitives): Describe
currently preferred approach to marking primitives as pure and
side-effect-free.
* doc/lispref/symbols.texi (Standard Properties): Expand description
of pure and side-effect-free properties.
2019-04-22 13:48:20 +01:00
Paul Eggert
ba809612c0 Merge from origin/emacs-26
2fcf2df Fix copyright years by hand
26bed8b Update copyright year to 2019
2814292 Fix value of default frame height.  (Bug#33921)
2018-12-31 17:57:29 -08:00
Paul Eggert
26bed8ba10 Update copyright year to 2019
Run 'TZ=UTC0 admin/update-copyright $(git ls-files)'.
2019-01-01 01:01:13 +00:00
Glenn Morris
23209e2c19 Merge from origin/emacs-26
913c001 * lisp/files.el (write-file): Clarify the doc string.  (Bug#3...
d614b84 Fix typos in midnight.el
8c2778a Improve documentation of 'move-file-to-trash'
c7b8a51 ; * doc/lispref/functions.texi (Anonymous Functions): Fix typo.
92296de * src/data.c (Ftype_of): xwidget objects are possible! (bug#3...
a3242cc Improve documentation of Diff mode
39e85a0 Note that lex bound lambda forms are not self-quoting (Bug#33...
fa605f2 Rewrite buffer display related doc-strings and doc
aa55659 Fix call to GlobalMemoryStatusEx in w32.c

# Conflicts:
#	doc/emacs/files.texi
#	src/data.c
2018-11-12 09:38:27 -08:00
Charles A. Roelli
c7b8a51b79 ; * doc/lispref/functions.texi (Anonymous Functions): Fix typo. 2018-11-10 20:32:36 +01:00
Noam Postavsky
39e85a0c6c Note that lex bound lambda forms are not self-quoting (Bug#33199)
* doc/lispref/functions.texi (Anonymous Functions):
* lisp/subr.el (lambda): Note that under lexical binding a lambda form
yields a closure object (Bug#33199).
2018-11-08 20:13:56 -05:00
Glenn Morris
3a739236d0 Merge from origin/emacs-26
eb903d8 * lisp/emacs-lisp/pcase.el: Improve docstrings.
86abbb3 * lisp/emacs-lisp/rx.el (rx): Fix typo in doc string.  (Bug#3...
ced58d3 Improve doc string of 'call-process'
38f88a7 Document that generic functions cannot be commands
5aeddfa * lisp/mail/rmailsum.el (rmail-summary-output): Add lost word...
10e0fd8 Add index entries for more isearch commands/bindings (Bug#32990)
de28184 * lisp/simple.el (filter-buffer-substring): Clarify doc (Bug#...
d192c16 Fix recent change in lispref/processes.texi.
2018-10-31 07:50:57 -07:00
Eli Zaretskii
38f88a7f00 Document that generic functions cannot be commands
* doc/lispref/commands.texi (Defining Commands):
* doc/lispref/functions.texi (Generic Functions): Document
that generic functions cannot be turned into commands.
(Bug#33170)
2018-10-30 12:14:19 +02:00
Glenn Morris
eb6c0c33f1 Merge from origin/emacs-26
ea77c65 Revert "Temporary workaround for bug #32848 for branch emacs-26"
2c8ea46 Revert "* etc/NEWS: Note setting make-cursor-line-fully-visib...
f8df6f2 * etc/NEWS: Note setting make-cursor-line-fully-visible to ni...
cdca208 Fix note about interactive advice (Bug#32905)
508c40e Comple fix for Bug#32550
2018-10-03 09:25:26 -07:00
Noam Postavsky
cdca208932 Fix note about interactive advice (Bug#32905)
* doc/lispref/functions.texi (Core Advising Primitives): Add missing
':', and finish the sentence fragment.
2018-10-02 20:07:40 -04:00
Glenn Morris
16c2f03c15 Merge from origin/emacs-26
bbc9d37 (origin/emacs-26) Fix previous change in minibuffer-default-a...
7caeef1 * src/editfns.c (Fformat): Make %x easier to spot in doc stri...
ecc29fb Improve responsiveness while in 'replace-buffer-contents'
8182d64 Improve documentation of 'server-start' and friends
decdfed Clarify wording about functions' argument lists
5abac8b * lisp/doc-view.el: Fix typos in the commentary.  (Bug#31937)
2018-06-23 07:51:00 -07:00
Eli Zaretskii
decdfedf02 Clarify wording about functions' argument lists
* doc/lispref/functions.texi (Argument List): Clarify the
wording.  (Bug#31872)
2018-06-23 10:38:44 +03:00
Glenn Morris
2a8f8f7563 Merge from origin/emacs-26
5de608f (origin/emacs-26) Update the documentation of 'perform-replace'
06245b6 * etc/NEWS: Another fix for the last change (noted by Juri Li...
8f6293c Fix use of @key in Texinfo manuals
f4c9894 Improve documentation of actual arglist
ce0e253 ; * etc/NEWS: Improve last change as proposed by Phil Sainty
b89ff0e Don't assume term-current-row cache is valid (Bug#31193)
326a296 ; * etc/NEWS: Mention 'display-buffer-in-major-side-window' c...
3bdc9a1 Fix flyspell-auto-correct-previous-word broken by recent change
a539eb5 * test/src/lread-tests.el (lread-test-bug-31186): New test.
3fa472b Fix undefined behaviour while looking for lexical-binding fil...
4341aac Minor wording improvement in "Bookmarks"

Conflicts:
	test/src/lread-tests.el
2018-04-20 08:07:43 -07:00
Eli Zaretskii
f4c989427b Improve documentation of actual arglist
* doc/lispref/functions.texi (Function Documentation): Advise
against using '(fn ARGLIST)' method of advertising a calling
convention when the old calling convention is deprecated.
(Bug#31191)
2018-04-19 11:29:50 +03:00
Glenn Morris
7d8234c0cb Merge from origin/emacs-26
9bff405 (origin/emacs-26) * doc/misc/org.texi (Installation): Fix clo...
613c9a5 Update Org to v9.1.9
1b075a9 ; Fix some tiny doc typos
441fe20 De-obsolete `if-let' and `when-let'
8696038 * lisp/htmlfontify.el (hfy-begin-span-handler): Doc fix.
930f7b1 * doc/lispref/functions.texi (Defining Functions): Improve in...
95ccf50 Fix crash after frame is freed on macOS (bug#30800)
45d0475 More manual editing
2acb9f0 Minor manual changes changes
d481cba * lisp/calculator.el (calculator-paste-decimals): Add version.
7d6c7d0 ; Use GNU not Gnu in docs
1bc4def More proofreading of the Emacs manual

Conflicts:
	doc/misc/org.texi
	etc/NEWS
	lisp/org/org-clock.el
2018-03-28 09:38:22 -07:00
Eli Zaretskii
930f7b10b3 * doc/lispref/functions.texi (Defining Functions): Improve indexing. 2018-03-26 18:58:20 +03:00
Noam Postavsky
1d47d777ef Allow &rest' or &optional' without following variable (Bug#29165)
This is sometimes convenient when writing macros, so that the empty
variable case doesn't need to be handled specially.  Older versions of
Emacs accepted this in some cases (especially the interpreter in Emacs
25 and below was very accepting).

                            |   interpreted/compiled   |
| arglist                   | 25 & earlier | 26  | 27  |
|---------------------------+--------------+-----+-----|
| (&rest)                   | y/n          | n/n | y/y |
| (&rest &rest)             | y/n          | n/n | n/n |
| (&rest &rest x)           | y/n          | n/n | n/n |
| (&rest x &rest)           | y/n          | n/n | n/n |
| (&rest x &rest y)         | y/n          | n/n | n/n |
|---------------------------+--------------+-----+-----|
| (&optional)               | y/n          | n/n | y/y |
| (&optional &optional)     | y/n          | n/n | n/n |
| (&optional x &optional)   | y/n          | n/n | n/n |
| (&optional x &optional y) | y/y          | n/n | n/n |
|---------------------------+--------------+-----+-----|
| (&optional &rest)         | y/n          | n/n | y/y |
| (&optional x &rest)       | y/n          | n/n | y/y |
| (&optional &rest y)       | y/y          | n/n | y/y |
|---------------------------+--------------+-----+-----|
| (&rest &optional)         | y/n          | n/n | n/n |
| (&rest &optional y)       | y/n          | n/n | n/n |
| (&rest x &optional y)     | y/n          | n/n | n/n |

The values in the table above can be produced with the following code:

(with-current-buffer (get-buffer-create "*ck-args*")
  (erase-buffer)
  (dolist (arglist '((&rest)
                     (&rest &rest)
                     (&rest &rest x)
                     (&rest x &rest)
                     (&rest x &rest y)
                     (&optional)
                     (&optional &optional)
                     (&optional x &optional)
                     (&optional x &optional y)
                     (&optional &rest)
                     (&optional x &rest)
                     (&optional &rest y)
                     (&rest &optional)
                     (&rest &optional y)
                     (&rest x &optional y)))
    (insert
     (format "%c/%c\n"
             (condition-case err
                 (progn (funcall `(lambda ,arglist 'ok))
                        ?y)
               (error ?n))
             (condition-case err
                 (progn (byte-compile-check-lambda-list arglist)
                        ?y)
               (error ?n))))
    (display-buffer (current-buffer))))

* src/eval.c (funcall_lambda):
* lisp/emacs-lisp/bytecomp.el (byte-compile-check-lambda-list): Don't
check for missing variables after `&rest' and `&optional'.
* test/src/eval-tests.el (eval-tests--bugs-24912-and-24913)
(eval-tests-accept-empty-optional-rest): Update tests accordingly.
* etc/NEWS: Update announcement accordingly.
* doc/lispref/functions.texi (Argument List): Update manual to
indicate that variable names are optional.
2018-03-25 07:56:35 -04:00
Glenn Morris
80c2bf6e16 Merge from origin/emacs-26
7e7f2ea (origin/emacs-26) * src/keyboard.c (syms_of_keyboard): Doc fi...
c0676d4 Improve documentation of X resources
d806d69 ; Use @minus for negative numbers in some texi files
4a8ea7d * lisp/international/mule.el (keyboard-coding-system): Doc fix.
8a73b80 Minor doc fixes, mostly for timestamp issues
361a8b9 * doc/emacs/mini.texi (Completion Styles): Improve indexing.
2dc24d5 Fix @findex and @vindex entries in manuals
76f5242 Document, in the Elisp manual, how to get a character's raw s...
5fb2957 Improvements in the Emacs manual
de17b8e Tiny doc/misc markup fixes
2018-02-24 07:50:30 -08:00
Paul Eggert
8a73b80aa4 Minor doc fixes, mostly for timestamp issues 2018-02-23 11:52:18 -08:00
Glenn Morris
a893a4db20 Merge from origin/emacs-26
6f495ab (origin/emacs-26) Another round of manual fixups
59344c4 * doc/lispref/customize.texi (Custom Themes): Clarify .el pre...
6386efc * doc/emacs/entering.texi (Entering Emacs): Another wording fix.
e21f018 * doc/lispref/functions.texi (Inline Functions): Fix typo (Bu...
1c2fb04 * lisp/imenu.el (imenu-generic-expression): Rephrase doc (Bug...
b90e91c Fix last change of @key markup
f180075 * doc/emacs/entering.texi (Entering Emacs): Fix markup.
2018-02-02 07:50:22 -08:00
Noam Postavsky
e21f0189f3 * doc/lispref/functions.texi (Inline Functions): Fix typo (Bug#30238). 2018-02-01 19:26:40 -05:00
Stephen Leake
c967ba1861 Fix description of 'struct' generic function specializer
Backport:

* doc/lispref/functions.texi (Generic Functions): Fix description of
'struct' specializer; it must be the named struct or a child, not a
parent.

(cherry picked from commit b6add8c7cf)
2018-01-04 16:24:19 -06:00
Stephen Leake
b6add8c7cf Fix description of 'struct' generic function specializer
* doc/lispref/functions.texi (Generic Functions): Fix description of
'struct' specializer; it must be the named struct or a child, not a
parent.
2018-01-02 07:38:19 -06:00
Paul Eggert
bb267f17f9 Merge from origin/emacs-26
63b04c11d5 Fix copyright years by hand
5c7dd8a783 Update copyright year to 2018
220a9ecba1 Merge from Gnulib
312c565566 Don't add empty keyboard macro to macro ring (Bug#24992)
39ca289a7a Allow customization of decoding of "man" command
f8240815ea * etc/NEWS: Add security consideration note on passphrase ...
0c78822c70 Fix subtle problem with scroll-down when scroll-margin is ...
acd289c5a4 Fix problems with indexing in User manual
b240c7846b * lisp/help.el (describe-key): Only (copy-sequence elt) wh...
e879a5444a * src/buffer.c (Frestore_buffer_modified_p): Fix bug#29846
81b1028b63 Improve documentation of 'inhibit-modification-hooks' and ...
7175496d7a Fix doc string of 'enable-recursive-minibuffers'
5b38406491 Fix documentation of delsel and of killing text

# Conflicts:
#	etc/NEWS
#	etc/refcards/ru-refcard.tex
2018-01-01 01:13:04 -08:00
Paul Eggert
5c7dd8a783 Update copyright year to 2018
Run admin/update-copyright.
2018-01-01 00:57:59 -08:00
Glenn Morris
3404a87f29 Merge from origin/emacs-26
34fcfc5 (origin/emacs-26, emacs-26) * lisp/emacs-lisp/inline.el (defi...
f7a62c2 Fix doc string of 'footnote-style-alist'
c3b6742 Improve documentation of selecting windows
861d110 Improve documentation of records
22b3075 * etc/NEWS: Mention the removal of pinentry.el.  (Bug#27445)
689526b Fix interactive spec of 'semantic-ia-show-variants'
90ca37f Fix documentation of 'mouse-drag-and-drop-region' and friends
d60faf3 Improve detection of speller version in ispell.el
a0e3b06 Document 'mouse-drag-and-drop-region' options and mention the...
164e84c Fix uses of 'nil' and 'non-nil' in manuals and a few more min...
798f07f Document that mode commands should be idempotent.
ad2a47c ; * src/xdisp.c (extend_face_to_end_of_line): Fix last change.
88ddf53 Fontify a CPP construct correctly when a comment follows with...
de7de9c Prevent infloop in redisplay on TTY frames
293720e Fix loss of documentation face in certain CC Mode doc comment...

# Conflicts:
#	etc/NEWS
#	lisp/mail/footnote.el
2017-12-22 13:23:16 -05:00
Martin Rudalics
164e84c977 Fix uses of 'nil' and 'non-nil' in manuals and a few more minor issues
* doc/emacs/building.texi (Grep Searching): Fix doc of
'grep-save-buffers'.
(Drag and Drop): Reorder paragraphs.  Fix doc of
'mouse-drag-and-drop-region'.
* doc/emacs/frames.texi (Word and Line Mouse):
* doc/emacs/search.texi (Other Repeating Search):
* doc/lispref/compile.texi (Compilation Functions):
* doc/lispref/files.texi (Directory Names):
* doc/lispref/functions.texi (Advising Named Functions):
* doc/lispref/keymaps.texi (Controlling Active Maps):
* doc/lispref/lists.texi (Association Lists):
* doc/lispref/windows.texi (Quitting Windows): Fix uses of
'non-nil' and 'nil'.
2017-12-22 09:20:41 +01:00
Eric Abrahamsen
94b52207cf Clarify manual section on &context specializer for methods
* doc/lispref/functions.texi (Generic Functions): Provide a little
  more information on how they work.
2017-12-14 12:59:07 -08:00
Eli Zaretskii
ca5eb0d0b7 Fix a typo in the ELisp manual
* doc/lispref/functions.texi (Obsolete Functions): Fix a typo.
(Bug#29068)
2017-10-30 20:45:39 +02:00
Glenn Morris
50f711e7fa Fix some duplicate words typos
* lisp/erc/erc.el (erc-hide-current-message-p):
* lisp/progmodes/flymake-proc.el (flymake-proc-diagnostic-type-pred):
* doc/lispref/display.texi (Bidirectional Display, Delayed Warnings):
* doc/lispref/functions.texi (Defining Functions):
* doc/lispref/os.texi (Terminal-Specific):
* doc/misc/sem-user.texi (Analyzer Debug):
* doc/misc/srecode.texi (Special Variables): Fix typos.
2017-10-27 20:45:23 -04:00
Eli Zaretskii
1436ce83d3 Fix a minor markup problem in ELisp manual
* doc/lispref/functions.texi (Mapping Functions): Fix the order of
@example and @group.  For the details, see
http://lists.gnu.org/archive/html/bug-texinfo/2017-09/msg00007.html.
2017-09-06 21:00:29 +03:00