Fix minor quoting problems in doc strings
This commit is contained in:
parent
da71c89ba3
commit
eeecac7ab9
15 changed files with 20 additions and 20 deletions
|
@ -65,7 +65,7 @@ and `am-pm' and `time-zone', both alphabetic strings.
|
||||||
|
|
||||||
For example, the form
|
For example, the form
|
||||||
|
|
||||||
'(24-hours \":\" minutes
|
\\='(24-hours \":\" minutes
|
||||||
(if time-zone \" (\") time-zone (if time-zone \")\"))
|
(if time-zone \" (\") time-zone (if time-zone \")\"))
|
||||||
|
|
||||||
would give military-style times like `21:07 (UTC)'."
|
would give military-style times like `21:07 (UTC)'."
|
||||||
|
|
|
@ -603,7 +603,7 @@ UML attribute strings are things like {abstract} or {leaf}."
|
||||||
(private . "-")
|
(private . "-")
|
||||||
)
|
)
|
||||||
"Association list of the form (SYMBOL . \"STRING\") for protection symbols.
|
"Association list of the form (SYMBOL . \"STRING\") for protection symbols.
|
||||||
This associates a symbol, such as 'public with the st ring \"+\".")
|
For example, it might associate the symbol `public' with the string \"+\".")
|
||||||
|
|
||||||
(define-overloadable-function semantic-format-tag-uml-protection-to-string (protection-symbol color)
|
(define-overloadable-function semantic-format-tag-uml-protection-to-string (protection-symbol color)
|
||||||
"Convert PROTECTION-SYMBOL to a string for UML.
|
"Convert PROTECTION-SYMBOL to a string for UML.
|
||||||
|
|
|
@ -4364,7 +4364,7 @@ option itself, into the file you specify, overwriting any
|
||||||
`custom-set-variables' and `custom-set-faces' forms already
|
`custom-set-variables' and `custom-set-faces' forms already
|
||||||
present in that file. It will not delete any customizations from
|
present in that file. It will not delete any customizations from
|
||||||
the old custom file. You should do that manually if that is what you
|
the old custom file. You should do that manually if that is what you
|
||||||
want. You also have to put something like `(load \"CUSTOM-FILE\")
|
want. You also have to put something like (load \"CUSTOM-FILE\")
|
||||||
in your init file, where CUSTOM-FILE is the actual name of the
|
in your init file, where CUSTOM-FILE is the actual name of the
|
||||||
file. Otherwise, Emacs will not load the file when it starts up,
|
file. Otherwise, Emacs will not load the file when it starts up,
|
||||||
and hence will not set `custom-file' to that file either."
|
and hence will not set `custom-file' to that file either."
|
||||||
|
|
|
@ -1060,8 +1060,8 @@ You can set this variable in your ~/.emacs. For example, to add rules for
|
||||||
`.foo' and `.bar' files, write
|
`.foo' and `.bar' files, write
|
||||||
|
|
||||||
(setq dired-guess-shell-alist-user
|
(setq dired-guess-shell-alist-user
|
||||||
'((\"\\\\.foo\\\\'\" \"FOO-COMMAND\")
|
\\='((\"\\\\.foo\\\\\\='\" \"FOO-COMMAND\")
|
||||||
(\"\\\\.bar\\\\'\"
|
(\"\\\\.bar\\\\\\='\"
|
||||||
(if condition
|
(if condition
|
||||||
\"BAR-COMMAND-1\"
|
\"BAR-COMMAND-1\"
|
||||||
\"BAR-COMMAND-2\"))))"
|
\"BAR-COMMAND-2\"))))"
|
||||||
|
|
|
@ -1332,7 +1332,7 @@ Works best when set in the hooks to various major modes.
|
||||||
`reformed-vi' means Viper words are like Emacs words \(as determined using
|
`reformed-vi' means Viper words are like Emacs words \(as determined using
|
||||||
Emacs syntax tables, which are different for different major modes) with two
|
Emacs syntax tables, which are different for different major modes) with two
|
||||||
exceptions: the symbol `_' is always part of a word and typical Vi non-word
|
exceptions: the symbol `_' is always part of a word and typical Vi non-word
|
||||||
symbols, such as `,',:,\",),{, etc., are excluded.
|
symbols like `\\=`', `\\='', `:', `\"', `)', and `{' are excluded.
|
||||||
This behaves very close to `strict-vi', but also works well with non-ASCII
|
This behaves very close to `strict-vi', but also works well with non-ASCII
|
||||||
characters from various alphabets.
|
characters from various alphabets.
|
||||||
|
|
||||||
|
|
|
@ -118,7 +118,7 @@ the header field or an empty string. If FIELD is an empty string, the
|
||||||
entire article body is searched for. REGEXP is a string which is
|
entire article body is searched for. REGEXP is a string which is
|
||||||
compared with FIELD value. COMMAND is a string representing a valid
|
compared with FIELD value. COMMAND is a string representing a valid
|
||||||
key sequence in Summary mode or Lisp expression. COMMAND defaults to
|
key sequence in Summary mode or Lisp expression. COMMAND defaults to
|
||||||
'(gnus-summary-mark-as-read nil \"X\"). Make sure that COMMAND is
|
\(gnus-summary-mark-as-read nil \"X\"). Make sure that COMMAND is
|
||||||
executed in the Summary buffer. If the second optional argument ALL
|
executed in the Summary buffer. If the second optional argument ALL
|
||||||
is non-nil, the COMMAND is applied to articles which are already
|
is non-nil, the COMMAND is applied to articles which are already
|
||||||
marked as read or unread. Articles which are marked are skipped over
|
marked as read or unread. Articles which are marked are skipped over
|
||||||
|
|
|
@ -46,7 +46,7 @@ Say you want to use the single score file
|
||||||
score files in the \"/ftp.some-where:/pub/score\" directory.
|
score files in the \"/ftp.some-where:/pub/score\" directory.
|
||||||
|
|
||||||
(setq gnus-global-score-files
|
(setq gnus-global-score-files
|
||||||
'(\"/ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE\"
|
\\='(\"/ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE\"
|
||||||
\"/ftp.some-where:/pub/score\"))"
|
\"/ftp.some-where:/pub/score\"))"
|
||||||
:group 'gnus-score-files
|
:group 'gnus-score-files
|
||||||
:type '(repeat file))
|
:type '(repeat file))
|
||||||
|
|
|
@ -153,7 +153,7 @@ These apply when the `starttls' command is used, i.e. when
|
||||||
These apply when GnuTLS is used, i.e. when `starttls-use-gnutls' is non-nil.
|
These apply when GnuTLS is used, i.e. when `starttls-use-gnutls' is non-nil.
|
||||||
|
|
||||||
For example, non-TLS compliant servers may require
|
For example, non-TLS compliant servers may require
|
||||||
'(\"--protocols\" \"ssl3\"). Invoke \"gnutls-cli --help\" to
|
\(\"--protocols\" \"ssl3\"). Invoke \"gnutls-cli --help\" to
|
||||||
find out which parameters are available."
|
find out which parameters are available."
|
||||||
:version "22.1"
|
:version "22.1"
|
||||||
:type '(repeat string)
|
:type '(repeat string)
|
||||||
|
|
|
@ -522,7 +522,7 @@ Some examples:\n
|
||||||
|
|
||||||
(defvar hfy-sheet-assoc 'please-ignore-this-line
|
(defvar hfy-sheet-assoc 'please-ignore-this-line
|
||||||
"An assoc with elements of the form (face-name style-name . style-string):\n
|
"An assoc with elements of the form (face-name style-name . style-string):\n
|
||||||
'((default \"default\" . \"{background: black; color: white}\")
|
\((default \"default\" . \"{background: black; color: white}\")
|
||||||
(font-lock-string-face \"string\" . \"{color: rgb(64,224,208)}\"))" )
|
(font-lock-string-face \"string\" . \"{color: rgb(64,224,208)}\"))" )
|
||||||
|
|
||||||
(defvar hfy-facemap-assoc 'please-ignore-this-line
|
(defvar hfy-facemap-assoc 'please-ignore-this-line
|
||||||
|
|
|
@ -26,7 +26,7 @@
|
||||||
|
|
||||||
(defun post-mail-send-it ()
|
(defun post-mail-send-it ()
|
||||||
"The MH -post interface for `rmail-mail' to call.
|
"The MH -post interface for `rmail-mail' to call.
|
||||||
To use it, include \"(setq send-mail-function 'post-mail-send-it)\" in
|
To use it, include \"(setq send-mail-function \\='post-mail-send-it)\" in
|
||||||
site-init."
|
site-init."
|
||||||
(let ((errbuf (if mail-interactive
|
(let ((errbuf (if mail-interactive
|
||||||
(generate-new-buffer " post-mail errors")
|
(generate-new-buffer " post-mail errors")
|
||||||
|
|
|
@ -303,7 +303,7 @@ The car of each element is a name of a constant, without the `$' before it.
|
||||||
The cdr is the value as a string. For example, if you'd like to use the
|
The cdr is the value as a string. For example, if you'd like to use the
|
||||||
speed of light in a formula, you would configure
|
speed of light in a formula, you would configure
|
||||||
|
|
||||||
(setq org-table-formula-constants '((\"c\" . \"299792458.\")))
|
(setq org-table-formula-constants \\='((\"c\" . \"299792458.\")))
|
||||||
|
|
||||||
and then use it in an equation like `$1*$c'.
|
and then use it in an equation like `$1*$c'.
|
||||||
|
|
||||||
|
|
|
@ -690,7 +690,7 @@ a list containing two strings: the name of the option, and the
|
||||||
value. For example,
|
value. For example,
|
||||||
|
|
||||||
(setq org-latex-listings-options
|
(setq org-latex-listings-options
|
||||||
'((\"basicstyle\" \"\\\\small\")
|
\\='((\"basicstyle\" \"\\\\small\")
|
||||||
(\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
|
(\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
|
||||||
|
|
||||||
will typeset the code in a small size font with underlined, bold
|
will typeset the code in a small size font with underlined, bold
|
||||||
|
@ -737,7 +737,7 @@ be a list containing two strings: the name of the option, and the
|
||||||
value. For example,
|
value. For example,
|
||||||
|
|
||||||
(setq org-latex-minted-options
|
(setq org-latex-minted-options
|
||||||
'((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
|
\\='((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
|
||||||
|
|
||||||
will result in src blocks being exported with
|
will result in src blocks being exported with
|
||||||
|
|
||||||
|
@ -758,7 +758,7 @@ It is used during export of src blocks by the listings and minted
|
||||||
latex packages. For example,
|
latex packages. For example,
|
||||||
|
|
||||||
(setq org-latex-custom-lang-environments
|
(setq org-latex-custom-lang-environments
|
||||||
'((python \"pythoncode\")))
|
\\='((python \"pythoncode\")))
|
||||||
|
|
||||||
would have the effect that if org encounters begin_src python
|
would have the effect that if org encounters begin_src python
|
||||||
during latex export it will output
|
during latex export it will output
|
||||||
|
|
|
@ -207,7 +207,7 @@ It is used during export of src blocks by the listings and
|
||||||
man packages. For example,
|
man packages. For example,
|
||||||
|
|
||||||
(setq org-man-custom-lang-environments
|
(setq org-man-custom-lang-environments
|
||||||
'((python \"pythoncode\")))
|
\\='((python \"pythoncode\")))
|
||||||
|
|
||||||
would have the effect that if org encounters begin_src python
|
would have the effect that if org encounters begin_src python
|
||||||
during man export."
|
during man export."
|
||||||
|
|
|
@ -852,7 +852,7 @@ ON-OR-OFF := t | nil
|
||||||
For example, with the following configuration
|
For example, with the following configuration
|
||||||
|
|
||||||
\(setq org-odt-table-styles
|
\(setq org-odt-table-styles
|
||||||
'((\"TableWithHeaderRowsAndColumns\" \"Custom\"
|
\\='((\"TableWithHeaderRowsAndColumns\" \"Custom\"
|
||||||
((use-first-row-styles . t)
|
((use-first-row-styles . t)
|
||||||
(use-first-column-styles . t)))
|
(use-first-column-styles . t)))
|
||||||
(\"TableWithHeaderColumns\" \"Custom\"
|
(\"TableWithHeaderColumns\" \"Custom\"
|
||||||
|
|
|
@ -306,9 +306,9 @@ This expression is a list of expressions that can involve the keywords
|
||||||
`seconds', all numbers in string form, and `monthname', `dayname', `am-pm',
|
`seconds', all numbers in string form, and `monthname', `dayname', `am-pm',
|
||||||
and `time-zone' all alphabetic strings, and `mail' a true/nil value.
|
and `time-zone' all alphabetic strings, and `mail' a true/nil value.
|
||||||
|
|
||||||
For example, the form
|
For example:
|
||||||
|
|
||||||
'((substring year -2) \"/\" month \"/\" day
|
((substring year -2) \"/\" month \"/\" day
|
||||||
\" \" 24-hours \":\" minutes \":\" seconds
|
\" \" 24-hours \":\" minutes \":\" seconds
|
||||||
(if time-zone \" (\") time-zone (if time-zone \")\")
|
(if time-zone \" (\") time-zone (if time-zone \")\")
|
||||||
(if mail \" Mail\" \"\"))
|
(if mail \" Mail\" \"\"))
|
||||||
|
|
Loading…
Add table
Reference in a new issue