diff options
| author | Stefan Kangas | 2022-09-10 07:29:48 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2022-09-10 07:29:48 +0200 |
| commit | 54c3794899ef2d4d88812fb445b6e2acc85a2720 (patch) | |
| tree | 328f8905c6b079b14bbf15b1f37abe6f9541a88c /src | |
| parent | ce4f354defd5f888dfc0bc8feba0396d734ee87f (diff) | |
| download | emacs-54c3794899ef2d4d88812fb445b6e2acc85a2720.tar.gz emacs-54c3794899ef2d4d88812fb445b6e2acc85a2720.zip | |
Doc fixes for 'text-quoting-style'
* doc/lispref/help.texi (Keys in Documentation): Remove duplicate
entry for 'text-quoting-style'. Document the function with the same
name instead.
* src/doc.c (Ftext_quoting_style): Doc fix: clarify the return values.
(syms_of_doc) <Vtext_quoting_style>: Doc fix: clarify that you should
not read the value of this variable directly; use Ftext_quoting_style
instead (bug#51040).
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc.c | 15 |
1 files changed, 13 insertions, 2 deletions
| @@ -643,7 +643,14 @@ default_to_grave_quoting_style (void) | |||
| 643 | DEFUN ("text-quoting-style", Ftext_quoting_style, | 643 | DEFUN ("text-quoting-style", Ftext_quoting_style, |
| 644 | Stext_quoting_style, 0, 0, 0, | 644 | Stext_quoting_style, 0, 0, 0, |
| 645 | doc: /* Return the current effective text quoting style. | 645 | doc: /* Return the current effective text quoting style. |
| 646 | See variable `text-quoting-style'. */) | 646 | If the variable `text-quoting-style' is `grave', `straight' or |
| 647 | `curve', just return that value. If it is nil (the default), return | ||
| 648 | `grave' if curved quotes cannot be displayed (for instance, on a | ||
| 649 | terminal with no support for these characters), otherwise return | ||
| 650 | `quote'. Any other value is treated as `grave'. | ||
| 651 | |||
| 652 | Note that in contrast to the variable `text-quoting-style', this | ||
| 653 | function will never return nil. */) | ||
| 647 | (void) | 654 | (void) |
| 648 | { | 655 | { |
| 649 | /* Use grave accent and apostrophe `like this'. */ | 656 | /* Use grave accent and apostrophe `like this'. */ |
| @@ -694,7 +701,11 @@ The value should be one of these symbols: | |||
| 694 | `grave': quote with grave accent and apostrophe \\=`like this\\='; | 701 | `grave': quote with grave accent and apostrophe \\=`like this\\='; |
| 695 | i.e., do not alter the original quote marks. | 702 | i.e., do not alter the original quote marks. |
| 696 | nil: like `curve' if curved single quotes are displayable, | 703 | nil: like `curve' if curved single quotes are displayable, |
| 697 | and like `grave' otherwise. This is the default. */); | 704 | and like `grave' otherwise. This is the default. |
| 705 | |||
| 706 | You should never read the value of this variable directly from a Lisp | ||
| 707 | program. Use the function `text-quoting-style' instead, as that will | ||
| 708 | compute the correct value for the current terminal in the nil case. */); | ||
| 698 | Vtext_quoting_style = Qnil; | 709 | Vtext_quoting_style = Qnil; |
| 699 | 710 | ||
| 700 | DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag, | 711 | DEFVAR_BOOL ("internal--text-quoting-flag", text_quoting_flag, |