masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-05 03:39:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Minor doc fixes for quoting

Browse source 
* 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.
This commit is contained in:
Paul Eggert 2016-05-05 06:39:17 -07:00
parent 3347a733e0
commit 5e814e02f0
3 changed files with 20 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/lispref/control.texi
View file

@ -1100,12 +1100,13 @@ These examples show typical uses of @code{error}:
error symbol @code{error}, and a list containing the string returned by error symbol @code{error}, and a list containing the string returned by
@code{format-message}. @code{format-message}.
A format that quotes with grave accents and apostrophes @t{`like The @code{text-quoting-style} variable controls what quotes are
this'} typically generates curved quotes @t{‘like this’}. In generated; @xref{Keys in Documentation}. A call using a format like
contrast, a format that quotes with only apostrophes @t{'like this'} @t{"Missing `%s'"} with grave accents and apostrophes typically
typically generates two closing curved quotes @t{’like this’}, an generates a message like @t{"Missing ‘foo’"} with matching curved
unusual style in English. @xref{Keys in Documentation}, for how the quotes. In contrast, a call using a format like @t{"Missing '%s'"}
@code{text-quoting-style} variable affects generated quotes. 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 @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} verbatim, don't just write @code{(error @var{string})}. If @var{string}

13
doc/lispref/display.texi
View file

@ -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 The string is also added to the @file{*Messages*} buffer, but without
text properties (@pxref{Logging Messages}). text properties (@pxref{Logging Messages}).
A format that quotes with grave accents and apostrophes @t{`like The @code{text-quoting-style} variable controls what quotes are
this'} typically generates curved quotes @t{‘like this’}. In generated; @xref{Keys in Documentation}. A call using a format like
contrast, a format that quotes with only apostrophes @t{'like this'} @t{"Missing `%s'"} with grave accents and apostrophes typically
typically generates two closing curved quotes @t{’like this’}, an generates a message like @t{"Missing ‘foo’"} with matching curved
unusual style in English. @xref{Keys in Documentation}, for how the quotes. In contrast, a call using a format like @t{"Missing '%s'"}
@code{text-quoting-style} variable affects generated quotes. 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, In batch mode, the message is printed to the standard error stream,
followed by a newline. followed by a newline.

19
etc/NEWS
View file

@ -1476,11 +1476,12 @@ display of diagnostics and help, but not of info. As the variable is
not intended for casual use, it is not a user option. not intended for casual use, it is not a user option.
+++ +++
** `message' now translates various sorts of single quotes in its ** Message-issuing functions like 'message' and 'error' now translate
format string according to the value of `text-quoting-style' (see various sorts of single quotes in their format strings according to
above). This translation cannot be disabled. To get the old the value of 'text-quoting-style' (see above). This translation
behavior of `message', use `format', which is not affected by cannot be disabled. To get the old behavior, use 'format', which is
`text-quoting-style', e.g. (message "%s" (format "...." foo bar)). not affected by 'text-quoting-style', e.g., (message "%s" (format
"...." foo bar)).
+++ +++
** substitute-command-keys now replaces quotes. ** substitute-command-keys now replaces quotes.
@ -1489,14 +1490,6 @@ value of 'text-quoting-style'. Doc strings in source code can use
either curved single quotes or grave accents and apostrophes. As either curved single quotes or grave accents and apostrophes. As
before, characters preceded by \= are output as-is. before, characters preceded by \= are output as-is.
+++
** Message-issuing functions 'error', 'message', etc. now convert quotes.
They use the new 'format-message' function instead of plain 'format',
so that they now follow user preference as per 'text-quoting-style'
when processing curved single quotes, grave accents, and apostrophes
in their format argument. To process % directives but not quotes, you
can use calls like (message "%s" (format FORMAT ARG1 ... ARGn)).
+++ +++
** The character classes [:alpha:] and [:alnum:] in regular expressions ** The character classes [:alpha:] and [:alnum:] in regular expressions
now match multibyte characters using Unicode character properties. now match multibyte characters using Unicode character properties.