1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-03-06 14:02:07 -08:00
Commit graph

4239 commits

Author SHA1 Message Date
Eli Zaretskii
eb11dae499 Improve documentation of column-related functions
* doc/lispref/text.texi (Primitive Indent, Columns):
* src/indent.c (Fcurrent_indentation, Fmove_to_column): Document
that column counting ignores invisible text.  (Bug#56837)
2022-07-30 19:34:38 +03:00
Eli Zaretskii
31a6a37d45 Improve indexing of keymap variables
* doc/lispref/maps.texi (Standard Keymaps):
* doc/lispref/display.texi (Button Buffer Commands)
(Button Properties):
* doc/lispref/keymaps.texi (Translation Keymaps): Improve indexing
of keymaps.  (Bug#56816)
2022-07-30 09:32:48 +03:00
Štěpán Němec
2c6a94c5b8 ; Correct the meaning of "cf." in tips.texi
Cf. e.g. https://en.wiktionary.org/wiki/cf.

* doc/lispref/tips.texi (Documentation Tips): Correct the meaning of
"cf.".
2022-07-29 09:42:21 +02:00
Eli Zaretskii
ba54f7e39c ; * doc/lispref/windows.texi (Window Sizes): Another typo. (Bug#56811) 2022-07-28 12:56:44 +03:00
Eli Zaretskii
7990d0c36a ; * doc/lispref/windows.texi (Window Sizes): Fix a typo. (Bug#56811) 2022-07-28 12:29:07 +03:00
Lars Ingebrigtsen
05df70e755 Revert the `...' documentation back to actual usage
* doc/lispref/tips.texi (Documentation Tips): Document how `...'
is really used now (bug#55780).  ‘...’ is not really used in the
Emacs sources.

(cherry picked from commit 1ed9c1c7f9)
2022-07-28 10:16:09 +02:00
Arash Esbati
4ea1f6c7f8 ; * doc/lispref/tips.texi (Documentation Tips): Fix typos. (Bug#56802) 2022-07-27 22:20:41 +03:00
Eli Zaretskii
2529e82002 ; * doc/lispref/functions.texi (Declare Form): Fix typo. 2022-07-23 12:56:00 +03:00
Eli Zaretskii
54c4ceb009 Update the documentation of 'declare' forms
* doc/lispref/compile.texi (Native-Compilation Variables): Mention
the 'declare' alternative for 'native-comp-speed'.
* doc/lispref/functions.texi (Declare Form): Document 'declare'
forms that were previously undocumented.
2022-07-23 12:54:07 +03:00
Eli Zaretskii
2b31e667be ;Improve documentation of locale-specific string comparison
* doc/lispref/strings.texi (Text Comparison): Mention the Unicode
collation rules and buffer-local case-tables.
2022-07-21 09:54:46 +03:00
Stefan Kangas
ba0871bef1 ; Fix typos: prefer American spelling 2022-07-13 13:04:22 +02:00
Eli Zaretskii
84a5d47125 ; Fix last change
* doc/lispref/compile.texi (Native-Compilation Variables): Explain
better what the value -1 of 'native-comp-speed' means.
2022-07-11 16:52:03 +03:00
Eli Zaretskii
41472f3b6c Document 'jit-lock-debug-mode'
* doc/lispref/modes.texi (Other Font Lock Variables): Document
'jit-lock-debug-mode'.
2022-07-03 08:40:54 +03:00
Stefan Kangas
dc3cb749f3 Remove obsolete cust-print from elisp index
* doc/lispref/edebug.texi (Printing in Edebug): Remove obsolete
library "cust-print" from index.
2022-06-30 22:37:21 +02:00
Basil L. Contovounesios
091b22cb12 Fix hash table function return values in manual
* doc/lispref/hash.texi (Hash Access): Reconcile documented return
values of puthash and clrhash with their respective
docstrings (bug#55562).
2022-06-28 10:03:53 +03:00
Lars Ingebrigtsen
e0bac17bbc Mention face quirks after the final line in the lispref manual
* doc/lispref/display.texi (Face Attributes): Mention the quirks
about point after the final line (bug#56011).
2022-06-17 14:18:20 +02:00
Lars Ingebrigtsen
22a832ad82 Mention the #f syntax from cl-prin1
* doc/lispref/objects.texi (Special Read Syntax): Mention #f,
which is in cl-prin1 output (bug#55853).
2022-06-09 15:22:21 +02:00
Eli Zaretskii
3ea9357d10 Update documentation of 'aset' and 'store-substring'
* doc/lispref/strings.texi (Modifying Strings): Adjust to
implementation changes: it is possible for the modified string to
have fewer or more bytes than the original.  Add recommendations
regarding unibyte vs multibyte strings and characters.  (Bug#55801)
2022-06-05 11:28:10 +03:00
Eli Zaretskii
92c5faafd7 Clarify documentation of 'string-to-unibyte'
* doc/lispref/nonascii.texi (Converting Representations): Clarify
what 'string-to-unibyte' does.  Reported by Richard Hansen
<rhansen@rhansen.org>.  (Bug#55777)
2022-06-04 10:06:43 +03:00
Lars Ingebrigtsen
a95d46e00f Make it explicit that a couple of _s in lispref are underscores
* doc/lispref/strings.texi (Custom Format Strings):
* doc/lispref/control.texi (pcase Macro): Make it explicit that
it's an underscore (bug#55742).
2022-06-01 17:56:45 +02:00
Ikumi Keita
edb48646f2 Fix Display Property manual example
* doc/lispref/display.texi (Display Property): Fix syntax of
example (bug#55736).

Copyright-paperwork-exempt: yes
2022-05-31 13:20:00 +02:00
Eli Zaretskii
fff770fb97 Fix a bad cross-reference in elisp.pdf
* doc/lispref/control.texi (pcase Macro): Fix a conditional
cross-reference (bug#55689).
2022-05-28 11:51:15 +03:00
Eli Zaretskii
ebea3415b0 Fix documentation of 'string-pad'
* doc/lispref/strings.texi (Creating Strings): Fix description of
'string-pad'.  (Bug#55688)
2022-05-28 10:55:01 +03:00
Lars Ingebrigtsen
177718bc6d Update string-to-number documentation to bignum Emacs
* doc/lispref/strings.texi (String Conversion): string-to-number
no longer converts integers to floating point numbers (bug#55334).
2022-05-09 11:57:46 +02:00
Eli Zaretskii
5bfac7c774 Provide reference for OTF tags in the ELisp manual
* doc/lispref/display.texi (Low-Level Font): Provide the canonical
reference URL for OTF tags.
2022-05-06 10:27:20 +03:00
Eli Zaretskii
3b6338c8c3 Improve documentation of font- and face-related attribute functions
* lisp/faces.el (face-attribute):
* src/xfaces.c (Fx_family_fonts):
* src/font.c (Ffont_get, Ffont_put): Improve and clarify the doc
strings.

* doc/lispref/display.texi (Low-Level Font): Document the :type
attribute of a font.  Improve documentation of 'font-get' and
'font-put'.
(Attribute Functions): Add cross-reference to the description of
face attributes.
2022-04-28 17:53:36 +03:00
Arash Esbati
3723415743 ; * doc/lispref/syntax.texi (Position Parse): Fix a typo. (Bug#55143) 2022-04-27 14:43:20 +03:00
Eli Zaretskii
9a78b235e9 Improve indexing in "Programmed Completion"
* doc/lispref/minibuf.texi (Programmed Completion): Improve
indexing.  (Bug#55095)
2022-04-24 22:37:09 +03:00
Eli Zaretskii
1e9b9f403a Improve documentation of 'set-fontset-font'
* doc/lispref/display.texi (Fontsets):
* src/fontset.c (Fset_fontset_font): Improve and clarify the
documentation of 'set-fontset-font'.  Rename the arguments to be
more self-explanatory.  (Bug#55086)
2022-04-24 09:56:22 +03:00
Eli Zaretskii
dbb2dd6939 ; Fix wording of "File Notifications" in the ELisp manual
* doc/lispref/os.texi (File Notifications): Fix typos,
punctuation, and wording.
2022-04-20 20:00:15 +03:00
Eli Zaretskii
4f27588a16 Clarify "idleness" in the ELisp manual
* doc/lispref/os.texi (Idle Timers): Clarify that waiting for
input with timeout doesn't make Emacs idle.  Suggested by Ignacio
<ignaciocasso@hotmail.com>.  (Bug#54371)
2022-04-08 09:48:15 +03:00
Lars Ingebrigtsen
c69a617742 Add notes about command modes and nativecomp interaction
* doc/lispref/commands.texi (Command Modes): Note interaction with
native-compile (bug#54437).

* src/data.c: Add comment about not being supported.

Do not merge to master.
2022-03-21 15:53:25 +01:00
Eli Zaretskii
11492259b1 ; * doc/lispref/display.texi (Overlay Arrow): More accurate text. 2022-03-17 14:55:59 +02:00
Eli Zaretskii
a9920473f6 Improve documentation of 'map-charset-chars'
* doc/lispref/nonascii.texi (Character Sets):
* src/charset.c (Fmap_charset_chars): Clarify the codepoint issue
in using 'map-charset-chars'.
2022-03-10 09:29:29 +02:00
Eli Zaretskii
e86eae21a9 Document better how to reset attributes of faces for new frames
* doc/lispref/display.texi (Attribute Functions):
* lisp/faces.el (set-face-attribute): Explain how to reset an
attribute's value for future frames.  (Bug#54156)
2022-02-26 09:41:05 +02:00
Lars Ingebrigtsen
5942504391 Reword face-remap-add-relative manual entry
* doc/lispref/display.texi (Face Remapping): Clarify the
face-remap-add-relative (bug#54114).
2022-02-23 12:58:50 +01:00
Philipp Stephani
3dfc8bff15 Fix indexing of module functions that return enumeration types.
Return types that consist of more than one word need to be enclosed in
braces, see Info node `(texinfo) Typed Functions'.  Otherwise they are
indexed incorrectly.

* doc/lispref/internals.texi (Module Misc, Module Nonlocal): Enclose
multi-word return types in braces.
2022-02-22 21:39:32 +01:00
Eli Zaretskii
1e4b04c540 Improve documentation of filling and justification commands
* doc/lispref/text.texi (Filling):
* lisp/textmodes/fill.el (fill-region-as-paragraph)
(default-justification, set-justification, justify-current-line):
Clarify "canonicalization" of spaces and the meaning of
justification styles.  (Bug#54047)
(set-justification-left, set-justification-right)
(set-justification-full): Improve wording of doc strings.
2022-02-18 09:47:44 +02:00
Philipp Stephani
e303cb1807 Fix indexing of module functions that return complex types.
Return types that consist of more than one word need to be enclosed in
braces, see Info node `(texinfo) Typed Functions'.  Otherwise they are
indexed incorrectly.

* doc/lispref/internals.texi (Module Values): Enclose multi-word
return types in braces.
2022-02-17 14:02:28 +01:00
Eli Zaretskii
cdcfeef13c Note in ELisp manual that too-wide images are truncated
* doc/lispref/display.texi (Showing Images): Note that images are
truncated at the window's edge.  (Bug#53952)
2022-02-12 14:28:45 +02:00
Daniel Martín
638247baa4 Fix typo in display.texi
* doc/lispref/display.texi (Making Buttons): Fix typo.  (Bug#53807)
2022-02-05 22:30:28 +02:00
Eli Zaretskii
31ef751f94 Clarify documentation of a "face's font"
* doc/lispref/display.texi (Attribute Functions)
(Face Attributes): Clarify that the :font attribute of a face and
the font returned by 'face-font' are by default for ASCII
characters.  (Bug#53664)
2022-01-31 19:29:54 +02:00
Juri Linkov
a1ac6bd47e * doc/lispref/windows.texi (Textual Scrolling): Remove obsolete text.
Remove text about scrolling the minibuffer from the buffer,
obsolete since Emacs 27 (bug#51210).
2022-01-12 20:59:21 +02:00
Eli Zaretskii
862faa64e5 ; * doc/lispref/modes.texi (Auto Major Mode): Clarification. (Bug#53199) 2022-01-12 14:36:56 +02:00
Eli Zaretskii
b477cff35d Clarify %g and %G time format specs
* src/timefns.c (Fformat_time_string):
* doc/lispref/os.texi (Time Parsing): Clarify %g/%G.  (Bug#52934)
2022-01-02 09:30:15 +02:00
Eli Zaretskii
19dcb237b5 ; Add 2022 to copyright years. 2022-01-01 02:45:51 -05:00
Eli Zaretskii
f11779f01b Improve documentation of 'M-X' and related features
* doc/emacs/m-x.texi (M-x): Index 'M-X'.
* doc/lispref/commands.texi (Interactive Call, Command Modes):
Mention 'M-X' and 'execute-extended-command-for-buffer'.

* etc/NEWS: Clarify that the '(declare (completion ...' and
'(declare (modes ...' forms have no effect by default.  Likewise
for '(interactive "..." MODE)' specs.  (Bug#52839)
2021-12-29 16:39:20 +02:00
Stefan Kangas
89a82182cb Improve documentation of read-multiple-choice
* doc/lispref/commands.texi (Reading One Event): Document optional
third argument help-string of read-multiple-choice.
2021-12-26 01:09:31 +01:00
Eli Zaretskii
16ed9fad2c ; * doc/lispref/frames.texi (Child Frames): Improve wording. 2021-12-19 19:27:41 +02:00
Martin Rudalics
f11b996a3c Clarify description of two mouse dragging parameters (Bug#52537)
* doc/lispref/frames.texi (Child Frames): Clarify description of
'top-visible' and 'bottom-visible' parameters (Bug#52537).
2021-12-19 17:59:15 +01:00