From 805204f3efdf3e9cb3ccd2783b7ba44f8c1fdb5a Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Tue, 3 May 2016 00:02:50 +0200 Subject: Mention what a missing :group does * doc/lispref/customize.texi (Common Keywords): Document that a missing :group reuses the group from the preceding item (bug#21601). --- doc/lispref/customize.texi | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'doc/lispref') diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index 14e6eb3ab25..de130d57d30 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi @@ -66,9 +66,13 @@ cause confusion.} @kindex group@r{, customization keyword} @item :group @var{group} -Put this customization item in group @var{group}. When you use -@code{:group} in a @code{defgroup}, it makes the new group a subgroup of -@var{group}. +Put this customization item in group @var{group}. If this keyword is +missing from a customization item, it'll be placed in the same group +as the previous customization item that had a @code{:group} spec (in +the same file). + +When you use @code{:group} in a @code{defgroup}, it makes the new +group a subgroup of @var{group}. If you use this keyword more than once, you can put a single item into more than one group. Displaying any of those groups will show this -- cgit v1.2.1 From 2ea2a2f1a5b5b2e1b20f1ee8c86058334d0a2652 Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 3 May 2016 08:02:16 -0700 Subject: Doc fixes for quoting * doc/emacs/text.texi, doc/lispintro/emacs-lisp-intro.texi: * doc/lispref/control.texi, doc/lispref/display.texi: * doc/lispref/help.texi, doc/lispref/strings.texi, lisp/subr.el: * src/callint.c, src/doprnt.c, src/editfns.c: Document quoting a bit more systematically. Problem reported by Alan Mackenzie (Bug#23425). --- doc/lispref/control.texi | 10 ++++++---- doc/lispref/display.texi | 10 ++++++---- doc/lispref/help.texi | 4 ++++ doc/lispref/strings.texi | 10 ++++++++-- 4 files changed, 24 insertions(+), 10 deletions(-) (limited to 'doc/lispref') diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index 3f48c458c02..75d8d284623 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi @@ -1100,10 +1100,12 @@ These examples show typical uses of @code{error}: error symbol @code{error}, and a list containing the string returned by @code{format-message}. -In a format string containing single quotes, curved quotes @t{‘like -this’} and grave quotes @t{`like this'} work better than straight -quotes @t{'like this'}, as @code{error} typically formats every -straight quote as a curved closing quote. +A format that quotes with grave accents and apostrophes @t{`like +this'} typically generates curved quotes @t{‘like this’}. In +contrast, a format that quotes with only apostrophes @t{'like this'} +typically generates two closing curved quotes @t{’like this’}, an +unusual style in English. @xref{Keys in Documentation}, for how the +@code{text-quoting-style} variable affects generated quotes. @strong{Warning:} If you want to use your own string as an error message verbatim, don't just write @code{(error @var{string})}. If @var{string} diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index c80f78c0e3b..b0cd8731fe2 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -265,10 +265,12 @@ properties, it is displayed with the specified faces (@pxref{Faces}). The string is also added to the @file{*Messages*} buffer, but without text properties (@pxref{Logging Messages}). -In a format string containing single quotes, curved quotes @t{‘like -this’} and grave quotes @t{`like this'} work better than straight -quotes @t{'like this'}, as @code{message} typically formats every -straight quote as a curved closing quote. +A format that quotes with grave accents and apostrophes @t{`like +this'} typically generates curved quotes @t{‘like this’}. In +contrast, a format that quotes with only apostrophes @t{'like this'} +typically generates two closing curved quotes @t{’like this’}, an +unusual style in English. @xref{Keys in Documentation}, for how the +@code{text-quoting-style} variable affects generated quotes. In batch mode, the message is printed to the standard error stream, followed by a newline. diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 58a11f29a4c..b945e438f55 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -335,10 +335,14 @@ specifies @var{mapvar}'s value as the keymap for any following @item ‘ @itemx ` (left single quotation mark and grave accent) both stand for a left quote. +This generates a left single quotation mark, an apostrophe, or a grave +accent depending on the value of @code{text-quoting-style}. @item ’ @itemx ' (right single quotation mark and apostrophe) both stand for a right quote. +This generates a right single quotation mark or an apostrophe +depending on the value of @code{text-quoting-style}. @item \= quotes the following character and is discarded; thus, @samp{\=`} puts diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi index 9d6613c522c..c6563f7e03c 100644 --- a/doc/lispref/strings.texi +++ b/doc/lispref/strings.texi @@ -834,8 +834,14 @@ if any. This function acts like @code{format}, except it also converts any curved single quotes in @var{string} as per the value of @code{text-quoting-style}, and treats grave accent (@t{`}) and -apostrophe (@t{'}) as if they were curved single quotes. @xref{Keys -in Documentation}. +apostrophe (@t{'}) as if they were curved single quotes. + +A format that quotes with grave accents and apostrophes @t{`like +this'} typically generates curved quotes @t{‘like this’}. In +contrast, a format that quotes with only apostrophes @t{'like this'} +typically generates two closing curved quotes @t{’like this’}, an +unusual style in English. @xref{Keys in Documentation}, for how the +@code{text-quoting-style} variable affects generated quotes. @end defun @cindex @samp{%} in format -- cgit v1.2.1 From 93703c547a96bc257d4e4c1ae4c84e60cf217810 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Tue, 3 May 2016 19:06:13 +0200 Subject: (Common Keywords): Correct what missing :group means * doc/lispref/customize.texi (Common Keywords): Correct what missing :group means. --- doc/lispref/customize.texi | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'doc/lispref') diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index de130d57d30..4a6f7f2162b 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi @@ -68,8 +68,7 @@ cause confusion.} @item :group @var{group} Put this customization item in group @var{group}. If this keyword is missing from a customization item, it'll be placed in the same group -as the previous customization item that had a @code{:group} spec (in -the same file). +that was last defined (in the current file). When you use @code{:group} in a @code{defgroup}, it makes the new group a subgroup of @var{group}. -- cgit v1.2.1 From 5e814e02f0b0b85fa486975eced09e4a7ed8ce5c Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Thu, 5 May 2016 06:39:17 -0700 Subject: Minor doc fixes for quoting * doc/lispref/control.texi (Signaling Errors): * doc/lispref/display.texi (Displaying Messages): Don’t say that formats “generate”. Try to word more clearly. * etc/NEWS: Coalesce near-duplicate entries. --- doc/lispref/control.texi | 13 +++++++------ doc/lispref/display.texi | 13 +++++++------ 2 files changed, 14 insertions(+), 12 deletions(-) (limited to 'doc/lispref') diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index 75d8d284623..0cdb03548bf 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi @@ -1100,12 +1100,13 @@ These examples show typical uses of @code{error}: error symbol @code{error}, and a list containing the string returned by @code{format-message}. -A format that quotes with grave accents and apostrophes @t{`like -this'} typically generates curved quotes @t{‘like this’}. In -contrast, a format that quotes with only apostrophes @t{'like this'} -typically generates two closing curved quotes @t{’like this’}, an -unusual style in English. @xref{Keys in Documentation}, for how the -@code{text-quoting-style} variable affects generated quotes. +The @code{text-quoting-style} variable controls what quotes are +generated; @xref{Keys in Documentation}. A call using a format like +@t{"Missing `%s'"} with grave accents and apostrophes typically +generates a message like @t{"Missing ‘foo’"} with matching curved +quotes. In contrast, a call using a format like @t{"Missing '%s'"} +with only apostrophes typically generates a message like @t{"Missing +’foo’"} with only closing curved quotes, an unusual style in English. @strong{Warning:} If you want to use your own string as an error message verbatim, don't just write @code{(error @var{string})}. If @var{string} diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index b0cd8731fe2..181bff09b55 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -265,12 +265,13 @@ properties, it is displayed with the specified faces (@pxref{Faces}). The string is also added to the @file{*Messages*} buffer, but without text properties (@pxref{Logging Messages}). -A format that quotes with grave accents and apostrophes @t{`like -this'} typically generates curved quotes @t{‘like this’}. In -contrast, a format that quotes with only apostrophes @t{'like this'} -typically generates two closing curved quotes @t{’like this’}, an -unusual style in English. @xref{Keys in Documentation}, for how the -@code{text-quoting-style} variable affects generated quotes. +The @code{text-quoting-style} variable controls what quotes are +generated; @xref{Keys in Documentation}. A call using a format like +@t{"Missing `%s'"} with grave accents and apostrophes typically +generates a message like @t{"Missing ‘foo’"} with matching curved +quotes. In contrast, a call using a format like @t{"Missing '%s'"} +with only apostrophes typically generates a message like @t{"Missing +’foo’"} with only closing curved quotes, an unusual style in English. In batch mode, the message is printed to the standard error stream, followed by a newline. -- cgit v1.2.1